How can I make a subscription change immediately using API?

Scope

How can I make a subscription change immediately using API?

What are the parameters to change subscriptions immediately via API?

Summary

In Chargebee, it's possible to apply subscription changes immediately via UI & API. You can allow customers to make changes to the subscription from the customer portal as well.

Solution

API Process:

1. Provide a click-to-action page: Example - Change subscription/Update subscription

2. Lists the current subscriptions for the customer where they can make the changes.

3. Use the Update a subscription for items API for PC 2.0 & Update a subscription API for PC 1.0 and ensure that the changes come into effect immediately.

4. In order to ensure that the customers are charged immediately, you can pass the invoice_immediately parameter as 'true'. (to unbilled charges, choose invoice_immediately parameter as 'false')

5. force_term_reset: Passing this parameter as true will have the subscription reset its term to the current date.

6. Note: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.

Note: If you use the invoice immediately parameter, it will charge the user for the total charge amount and the previously charged amount will be added to credits, however, if you prefer to perform proration, please refer to this link here and then use prorate as 'true' there would be a proration on the renewal and an invoice will be generated.

Note

1. If you are using our APIs the change subscription action should be initiated from outside of the Chargebee portal. Example, a change subscription button on your end/website.
2. In case of resuming a paused subscription, the customer will be charged immediately if the reactivation occurs out of the current term.