POST /subscriptions/{subscription-id}/reactivate

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Valid values:

• "all-disabled"

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.

skip all actions to be done on the events

Valid values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

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.

skip only emails

Valid values:

• "all-disabled"

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"

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.

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. * delayed - Subscription period will be aligned with the configured billing date at the next renewal. * immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly..

Valid values:

• "immediate"
• "delayed"

Parameters for payment_intent

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.

The gateway account used for performing the 3DS flow.

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. * card - card * netbanking_emandates - netbanking_emandates * payconiq_by_bancontact - Payconiq by Bancontact * dotpay - dotpay * faster_payments - Faster Payments * upi - upi * direct_debit - direct_debit * sepa_instant_transfer - Sepa Instant Transfer * bancontact - bancontact * google_pay - google_pay * apple_pay - apple_pay * online_banking_poland - Online Banking Poland * giropay - giropay * paypal_express_checkout - paypal_express_checkout * venmo - Venmo * klarna_pay_now - Klarna Pay Now * sofort - sofort * amazon_payments - Amazon Payments * ideal - ideal * pay_to - PayTo * boleto - boleto

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"

• 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

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.

Identifier for Braintree permanent token. Applicable when you are using Braintree APIs for completing the 3DS flow.

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 date/time at which the subscription was reactivated. When not provided, the subscription is reactivated immediately on calling this API. The value of this parameter must always be in the past (backdating). Do this when the subscription has already been reactivated and the billing has been delayed. The following prerequisites must be met for this parameter to be passed:

• 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.
• The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, reactivate_from cannot be earlier than 14th February.

The document date displayed on the invoice PDF. The default value is the current date. 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. When passing this parameter, the following prerequisites must be met:

• invoice_date must be in the past.
• invoice_date is not 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.
• It is not earlier than reactivate_from or trial_end.
• invoice_immediately is true.

Parameters for contract_term

Action to be taken when the contract term completes.

• evergreen - Contract term completes and the subscription renews.
• renew -
• Contract term completes and a new contract term is started for the number of billing cycles specified in contract_billing_cycle_on_renewal.
• The action_at_term_end for the new contract term is set to renew.
• cancel - Contract term completes and subscription is canceled.

Valid values:

• "evergreen"
• "cancel"
• "renew"

The number of days before contract_end, during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure.

Default value: 0

Parameters for statement_descriptor

Payment transaction descriptor text to help your customer easily recognize the transaction. When this value is passed this will override the transaction descriptor text configured in the Chargebee site for all the subscription renewal transactions.

Providing this parameter indicates that the subscription reactivates with an in_trial status and the trial period ends at the date provided. The value must not be earlier than reactivate_from. Note: This parameter can be backdated (set to a value in the past) only when reactivate_from has been backdated. Do this to keep a record of when the trial ended in case it ended at some point in the past. When trial_end is backdated, the subscription immediately goes into active or non_renewing status.

Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as billing_cycles or a custom value depending on the site configuration.

Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.