Reactivates a canceled subscription.
Use this operation to restore a canceled subscription to an active or in-trial state.
Extend non-renewing subscriptions
To extend the billing cycles of a non_renewing subscription, use the Remove scheduled cancellation API.
Prerequisites & Constraints
- The subscription
statusmust becancelled.
Impacts
Subscription
- For subscriptions canceled due to payment failure, in-term reactivation is governed by the Chargebee Billing configuration for reactivation.
Invoice
If an invoice gets generated during this operation, customer balances such as promotional credits, excess payments, and refundable credits are automatically applied subject to limits set at the site level which can be overridden for subscriptions via subscription.billing_override.
Use Cases
Use the payment_intent parameter to create a payment source for the customer. If reactivation generates an invoice and auto_collection is on, Chargebee immediately attempts payment collection using the new payment source.
Note
- This works for both Strong Customer Authentication (SCA) (i.e. 3D-Secure) and non-SCA flows.
- The payment source replaces the existing primary payment source for the customer.
- Create a
payment_intentresource by calling the Create a payment intent API. - Pass the
payment_intentobject to your frontend and use Chargebee.js to capture the payment source details from the customer. You can use Payment Components to capture the payment source details. - Listen to the
payment_intent_updatedevent. Once thepayment_intent.statusisauthorized, pass thepayment_intent.idusing thepayment_intent[id]parameter in this API call.
Related APIs
Remove scheduled cancellation
Sample Request
URL Format
Input Parameters
Providing this parameter indicates that the subscription reactivates with an in_trial status and the trial period ends at the date provided.
Constraints
- Must not be earlier than
reactivate_fromifreactivate_fromis provided. - When
trial_endis backdated, the subscription immediately goes intoactiveornon_renewingstatus.
The number of billing cycles (including the current cycle) this subscription should remain active for. After the billing cycles are exhausted, the subscription is canceled automatically.
Default value
- If not specified, the billing cycles configured for the plan are used.
Impact
- The
remaining_billing_cyclesattribute of the subscription is updated to one less than the value of this parameter.
The date-time at which the subscription was reactivated. When not provided, the subscription is reactivated immediately on calling this API.
Prerequisites
- The backdating feature has been enabled for subscription reactivation operations.
- The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is the day of the month by which the accounting for the previous month must be closed.
Constraints
- Must be in the past.
- Must not be more than the billing period of the plan into the past. For example, if the period of the plan in the subscription is 2 months and today is 14th April,
reactivate_fromcannot be earlier than 14th February. - Must not be after
trial_endiftrial_endis provided.
If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to unbilled charges. The default value is as per the site settings .
Note:
invoice_immediately
only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter.
.
Applicable when calendar billing is enabled and a new active term gets started during this operation. Unless specified the configured default value will be used.
Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.
Subscription period will be aligned with the configured billing date at the next renewal.
The number of subscription billing cycles to invoice in advance.
If a new term is started for the subscription due to this API call, then terms_to_charge
is inclusive of this new term. See description for the force_term_reset
parameter to learn more about when a subscription term is reset.
The document date displayed on the invoice PDF. 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 the 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.
Default value
- Current date.
Constraints
- Must be in the past.
- Must not be 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.
- Must not be earlier than
reactivate_fromortrial_end. invoice_immediatelymust betrue.
The number of billing cycles the new contract term should run for, on contract renewal. This value is used when action_at_term_end is renew.
Constraints
- Should not be sent when
contract_term.action_at_term_endiscancelorevergreen.
Default value
- Defaults to the value of
billing_cycleor a custom value depending on the site configuration.
The initiator of this payment request. Sending this information can improve the success rate of the payment at the gateway.
The payment was initiated by your customer.
The payment was initiated by you (the merchant).
statement_descriptor[<param name>]