ChargebeeAPI

Resume a subscription

Idempotency Supported
Try in API Explorer

Note: This operation optionally supports 3DS verification flow. To achieve the same, create the Payment Intent and pass it as input parameter to this API.

This API is used to resume a paused subscription. On resumption the subscription will be activated and any applicable charges will be initiated.

You could schedule the resumption by passing specific_date parameter in resume_option. If scheduled, the subscription will be resumed on the specific_date and moved to Active state.

For in-term resumption, unless there are scheduled changes, unbilled charges will not be charged.

What is an "in-term resumption"? An "in-term resumption" is when the pause and resumption happens within the billing term of the subscription.

Example : A subscription was billed from 1st to 31st of a month. It was paused on the 20th and resumed before 31st. This is an in-term resumption.

UNPAID INVOICES

Specifying unpaid_invoices allows you to close invoices of the subscription which have amounts due. The invoices are chosen for payment collection after applying the available credits and excess payments.

If you specify schedule_payment_collection, Chargebee will try to collect payments for overdue invoices, provided that auto_collection is enabled for the subscription. The available payment method is charged. Upon successful payment, the payment_succeeded event is triggered. If the payment collection fails, no further attempts will be made to collect payment 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.

Warning

This API will return an error when multi-frequency billing is enabled.

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/subscriptions/{subscription-id}/resume

Input Parameters

resume_option
optional, enumerated string

List of options to resume the subscription.

Possible Enum Values
immediately

Resume immediately

specific_date

Resume on a specific date

resume_date
optional, timestamp(UTC) in seconds

Date on which the subscription will be resumed. Applicable when resume_option is set as 'specific_date'.

charges_handling
optional, enumerated string

Applicable when charges get added during this operation and resume_option is set as 'immediately'. Allows to raise invoice immediately or add them to unbilled charges.

Possible Enum Values
invoice_immediately

Invoice immediately

add_to_unbilled_charges

Add to unbilled charges

unpaid_invoices_handling
optional, enumerated string

Applicable when the subscription has past due invoices and resume_option is set as 'immediately'. Allows to collect past due invoices or retain them as unpaid. If 'schedule_payment_collection' option is chosen in this field, remaining refundable credits and excess payments are applied. Note: The payment collection attempt will be asynchronous.

Possible Enum Values
no_action

Retain as unpaid

schedule_payment_collection

Collect payment

payment_initiator
optional, enumerated string

The type of initiator to be used for the payment request triggered by this operation.

Possible Enum Values
customer

Pass this value to indicate that the request is initiated by the customer

merchant

Pass this value to indicate that the request is initiated by the merchant

payment_intent
optional, string

Parameters for payment_intent

Returns

subscriptionSubscription object

Resource object representing subscription

customerCustomer object

Resource object representing customer

cardCard object

Resource object representing card

invoiceInvoice object

Resource object representing invoice

unbilled_chargesoptional

Resource object representing unbilled_charge