Cancelling a subscription will move the subscription from its current state to Cancelled, and will stop all recurring actions.
You could schedule the cancellation by passing end_of_term parameter as true. If scheduled, the subscription status will be set to non_renewing if it is in active state, until the end of term, and then cancelled. A subscription's state will not change if it is in in_trial state. However, cancellation will be scheduled at the end of the trial.
CREDIT OPTION
On subscription cancellation, credits can be issued against current term charges of the subscription by using credit_option_for_current_term_charges. You can choose to either provide no credits, prorate credits for the unused period or issue full credits for the current term charges.
UNBILLED CHARGES
Any unbilled charges present in the subscription can either be invoiced or deleted by specifying unbilled_charges_option. Note that automatic charge will be attempted on the payment method available if the customer has enabled auto-collection. If not, the invoice will be closed as unpaid.
ACCOUNT RECEIVABLES
Specifying account_receivables_handling allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection or for writing off the due amount after applying the available credits and excess payments.
If specified as schedule_payment_collection, payment collection for the amount due of past invoices will be attempted. The payment method available will be charged if auto-collection is enabled for the customer, and appropriate payment collection(payment succeeded or payment failed) events will be triggered. If the payment collection fails, no further retries will be made on the invoices. Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are cancelled, these invoices will not be selected for collection.
If specified as write_off, the amount due of past invoices will be written-off. Note: If the invoices of the subscription are consolidated, and any of the subscriptions in the consolidated invoice are still active(future, in-trial, active, and non-renewing), these invoices will not be selected for the write-off operation.
ACCOUNT PAYABLES
Specifying refundable_credits_handling allows you to provide refunds for refundable credits remaining, after they are applied to a subscription's due invoices. The refund initiated will be asynchronous and the payment refunded event will be triggered on refund success. Note: Consolidated credit notes of the subscription will not be selected for refund.
Contract terms
If the subscription has contract terms, it can only be canceled by terminating the contract using the contract_term_cancel_option. The contract term and the subscription are canceled together.
Contract terms parameters
-
contract_term_cancel_option -
cancel_at -
credit_option_for_current_term_charges -
unbilled_charges_option -
account_receivables_handling -
refundable_credits_handling
Advance charges, if any, will be refunded as credits.
Sample Request
URL Format
Input Parameters
If the subscription does not have a contract term:
Determines when to cancel the subscription.
If the subscription has a contract term:
This parameter is not applicable.
This is used to cancel the subscription with immediate effect
This is used to cancel a subscription at the end of the current billing cycle
This is used to cancel a subscription on a specified date. The change occurs as of the date/time defined in cancel_at
This is used to cancel a subscription either at the end of the advance term, if it's billed for future renewals or at the end of its current billing cycle
(Deprecated) Use cancel_option instead.
Applicable only when the subscription does not have contract terms.
Set this to true if you want to cancel the subscription at the end of the current subscription billing cycle. The subscription status changes to non_renewing.
If the subscription does not have a contract term:
Specifies the date and time when the subscription should be canceled. Do not use this parameter when end_of_term is set to true.
If the subscription has a contract term:
Applicable only when contract_term_cancel_option is specific_date. Specifies the date and time to cancel the subscription and contract term.
Backdating
You can set a past date to backdate the cancellation. Backdating is allowed only if the following conditions are met:
- Backdating is enabled for subscription cancellation.
- The current date does not exceed the backdating limit configured in Chargebee Billing.
- The date is on or after the
current_term_start. - The date is on or after the most recent change involving:
- Addition/change/removal of plan or addon item prices.
- Addition of charge item prices.
- The date is not more than one billing period into the past. For example, if the plan's billing period is two months and today is April 14,
cancel_atcannot be earlier than February 14.
If the subscription does not have a contract term:
Specifies how to handle credits for current term charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
If the subscription has a contract term:
Specifies how to handle credits for current term charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No credits notes are created.
Prorated credits are issued.
Credits are issues for the full value of the current term charges.
If the subscription does not have a contract term:
Specifies how to handle unbilled charges when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
If the subscription has a contract term:
Specifies how to handle unbilled charges when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
An invoice is generated immediately with the unbilled charges.
The unbilled charges are deleted.
If the subscription does not have a contract term:
Specifies how to handle past due invoices when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
If the subscription has a contract term:
Specifies how to handle past due invoices when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No action is taken.
Applies excess payments and refundable credits to past due invoices. If any amount remains and auto_collection
is on
, the remaining amount is automatically charged to the available payment method.
Applies excess payments and refundable credits to past due invoices. Any remaining balance is written off.
Note: The credit note for the write-off is not included in the API response.
If the subscription does not have a contract term:
Specifies how to handle refundable credits when canceling immediately (i.e., cancel_option is immediately). If not specified, the site-level setting is used.
If the subscription has a contract term:
Specifies how to handle refundable credits when contract_term_cancel_option is terminate_immediately. If not specified, the site-level setting is used.
No action is taken.
Refunds remaining credits after applying them to any past due invoices.
Required when the subscription has a contract term. Determines when to cancel the subscription along with the contract term.
Cancels the subscription and contract term immediately. Sets the contract term's status to terminated and collects any termination fee, if applicable.
To specify the termination fee, include a single object in the subscription_items array. If not specified, the default termination fee is applied (if configured).
Prevents the contract term from renewing and schedules the subscription for cancellation at the end of the contract term.
Cancels the subscription and contract term on the date specified by cancel_at. Sets action_at_term_end to cancel.
Note: Contact Chargebee Support to enable this option for your Chargebee site.
Cancels the subscription and contract term at the end of the current billing cycle. Sets action_at_term_end to cancel.
Note: Contact Chargebee Support to enable this option for your Chargebee site.
The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if create_pending_invoices
is true
, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes
and line_item_taxes
are computed based on the tax
configuration as of invoice_date.
When passing this parameter, the following prerequisites must be met:
invoice_datemust be in the past.invoice_dateis not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.- It is not earlier than
cancel_at. .
Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Subscriptions > Subscription Cancellation. Must be passed if set as mandatory in the app. The codes are case-sensitive.
Returns
Resource object representing subscription
Resource object representing customer
Resource object representing card
Resource object representing invoice
Resource object representing unbilled_charge
Resource object representing credit_note