POST /subscriptions/{subscription-id}/remove_scheduled_cancellation

Removes a scheduled cancellation from a subscription so that it continues billing for the specified number of billing cycles. Use this operation when a customer changes their mind about canceling their subscription.

Prerequisites & Constraints

There must be a cancellation scheduled for the subscription.
Do not invoke this API if the subscription has a contract_term associated with it.
The subscription must not be a gift subscription.
The subscription status must be in_trial, active or non_renewing.

Impacts

Subscription

The scheduled cancellation is removed.
If the subscription status is in_trial, it does not change.
If the subscription status is not in_trial, it becomes active.
subscription.remaining_billing_cycles is set to the value of billing_cycles.
If contract_term is provided, then a new contract_term is created on the subscription.

Implementation Notes

Before calling this API, perform the following checks:

Check the cancelled_at attribute. It must be set to a future date-time, indicating that a cancellation is scheduled.
Ensure that the contract_term attribute is not present.
Confirm that the subscription status is in_trial, active or non_renewing.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`subscription-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Valid values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Valid values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.
`chargebee-event-email`	String	No	skip only emails Valid values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`contract_term`	Object	No	Parameters for contract_term
`contract_term.action_at_term_end`	String	No	Action to be taken when the contract term completes. * cancel - Contract term completes and subscription is canceled. * evergreen - Contract term completes and the subscription renews. * renew - Contract term completes and a new contract term is started for the number of billing cycles specified in `contract_billing_cycle_on_renewal`. The `action_at_term_end` for the new contract term is set to `renew`. Valid values: `"evergreen"` `"cancel"` `"renew"`
`contract_term.cancellation_cutoff_period`	Integer	No	The number of days before `contract_end` , during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure. Default value: 0
`contract_term_billing_cycle_on_renewal`	Integer	No	Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as `billing_cycles` or a custom value depending on the site configuration .
`billing_cycles`	Integer	No	The number of billing cycles the subscription should remain active for after the current billing cycle. The `remaining_billing_cycles` attribute of the subscription is updated to this value. Constraints The value must be greater than 0. Default Value If not specified, the value set for `billing_cycles` on the subscription's plan item price is used.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.