POST /subscriptions/{subscription-id}/resume

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.

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
`payment_initiator`	String	No	The type of initiator to be used for the payment request triggered by this operation. * 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 Valid values: `"merchant"` `"customer"`
`payment_intent`	Object	No	Parameters for payment_intent
`payment_intent.id`	String	No	Identifier for PaymentIntent generated by Chargebee.js. Applicable only when you are using Chargebee.js for completing the 3DS flow. The PaymentIntent should be in 'authorized' state while passing it here. You need not pass other PaymentIntent parameters if this is passed.
`payment_intent.gateway_account_id`	String	No	The gateway account used for performing the 3DS flow.
`payment_intent.payment_method_type`	String	No	The list of payment method types (For example, card, ideal, sofort, bancontact, etc.) this Payment Intent is allowed to use. If payment method type is empty, Card is taken as the default type for all gateways except Razorpay. * online_banking_poland - Online Banking Poland * giropay - giropay * paypal_express_checkout - paypal_express_checkout * card - card * venmo - Venmo * klarna_pay_now - Klarna Pay Now * sofort - sofort * amazon_payments - Amazon Payments * netbanking_emandates - netbanking_emandates * payconiq_by_bancontact - Payconiq by Bancontact * dotpay - dotpay * ideal - ideal * faster_payments - Faster Payments * upi - upi * direct_debit - direct_debit * sepa_instant_transfer - Sepa Instant Transfer * bancontact - bancontact * pay_to - PayTo * boleto - boleto * google_pay - google_pay * apple_pay - apple_pay Valid values: `"bancontact"` `"upi"` `"amazon_payments"` `"online_banking_poland"` `"direct_debit"` `"sofort"` `"boleto"` `"netbanking_emandates"` `"giropay"` `"paypal_express_checkout"` `"apple_pay"` `"pay_to"` `"venmo"` `"payconiq_by_bancontact"` `"card"` `"klarna_pay_now"` `"dotpay"` `"faster_payments"` `"sepa_instant_transfer"` `"google_pay"` `"ideal"`
`payment_intent.additional_information`	Object	No	`checkout_com`: While adding a new payment method using permanent token or passing raw card details to Checkout.com, `document` ID and `country_of_residence` are required to support payments through dLocal. `payer`: User related information. `country_of_residence`: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code. `document`: Document ID is the user’s identification number based on their country. `bluesnap`: While passing raw card details to BlueSnap, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions. `fraud`: Fraud identification related information. `fraud_session_id`: Your BlueSnap fraud session ID required to perform anti-fraud validation. `braintree`: While passing raw card details to Braintree, your `fraud_merchant_id` and the user’s `device_session_id` can be added to perform additional validation and avoid fraudulent transactions. `fraud`: Fraud identification related information. `device_session_id`: Session ID associated with the user's device. `fraud_merchant_id`: Your merchant ID for fraud detection. `chargebee_payments`: While passing raw card details to Chargebee Payments, if `fraud_session_id` is added, additional validation is performed to avoid fraudulent transactions. `fraud`: Fraud identification related information. `fraud_session_id`: Your Chargebee Payments fraud session ID required to perform anti-fraud validation. `bank_of_america`: While passing raw card details to Bank of America, your user’s `device_session_id` can be added to perform additional validation and avoid fraudulent transactions. `fraud`: Fraud identification related information. `device_session_id`: Session ID associated with the user's device. `ecentric`: This parameter is used to verify and process payment method details in Ecentric. If the `merchant_id` parameter is included, Chargebee will vault it / perform a lookup and verification against this `merchant_id`, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part. `merchant_id`: Merchant GUID where the card is vaulted or need to be vaulted. `ebanx`: While passing raw card details to EBANX, the user's `document` is required for some countries and `device_session_id` can be added to perform additional validation and avoid fraudulent transactions. `payer`: User related information. `document`: Document is the user's identification number based on their country. `fraud`: Fraud identification related information. `device_session_id`: Session ID associated with the user's device
`payment_intent.gw_token`	String	No	Identifier for 3DS transaction/verification object at the gateway. Can be passed only after successfully completing the 3DS flow. Refer 3DS implementation in Chargebee to find out the gateway-specific gw_token format. Applicable when you are using gateway APIs directly for completing the 3DS flow.
`payment_intent.reference_id`	String	No	Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.
`resume_date`	Integer	No	Date on which the subscription will be resumed. Applicable when resume_option is set as 'specific_date'.
`unpaid_invoices_handling`	String	No	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. * no_action - Retain as unpaid * schedule_payment_collection - Collect payment Valid values: `"schedule_payment_collection"` `"no_action"`
`resume_option`	String	No	List of options to resume the subscription. * specific_date - Resume on a specific date * immediately - Resume immediately Valid values: `"immediately"` `"specific_date"`
`charges_handling`	String	No	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. * add_to_unbilled_charges - Add to unbilled charges * invoice_immediately - Invoice immediately Valid values: `"invoice_immediately"` `"add_to_unbilled_charges"`

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.