POST /subscriptions/{subscription-id}/remove_scheduled_changes

Removes a scheduled change from a subscription.

Review the changes before removing them

To review the scheduled subscription change before removing it, call Retrieve with scheduled changes before calling this API to retrieve the subscription resource with the scheduled change applied.

Prerequisites & Constraints

The subscription's has_scheduled_changes attribute is true.
The subscription has exactly one scheduled change. If multiple ramps exist, the API returns an error.

Impacts

Subscription

Removes the scheduled change.
Clears changes_scheduled_at, if set.
Sets has_scheduled_changes to false.

Invoices

If any advance invoices account for the scheduled change, Chargebee creates credit notes against those invoices.

Credit Notes

Creates the following credit notes against any advance invoices that account for the scheduled change:
- adjustment: for amount_to_collect on the advance invoice.
- refundable: for the refundable amount on the advance invoice.

Implementation Notes

Before you call this API, confirm the following:

The subscription's has_scheduled_changes attribute is true.
Exactly one scheduled change exists. To verify, call List ramps and filter by subscription_id. The response must include exactly one ramp object.

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
`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"`

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.