Pauses the subscription, changing its status to paused. This prevents the subscription from getting renewed. No new charges are created until the subscription is resumed.
Note:
- Applicable only for active/non-renewing subscriptions.
- If paused indefinitely, the subscription is cancelled on the
cancelled_atdate. - Advance charges, if any, are refunded as credits.
Sample Request
URL Format
Input Parameters
List of options to pause the subscription.
Pause immediately
Pause at the end of current term
Pause on a specific date
Pause at the end of the current term, and resume automatically after the set number of billing cycles (in skip_billing_cycles) have been skipped
Date on which the subscription will be paused. Applicable when specific_date option is chosen in the pause_option field.
For non-renewing subscriptions, pause_date should be before the cancellation date.
Applicable when unbilled charges are present for the subscription and pause_option is set as immediately. Note: On the invoice raised, an automatic charge is attempted on the payment method available, if customer's auto-collection property is set to on.
Retain as unbilled
If no_action is chosen, charges are added to the resumption invoice.
Invoice charges
If invoice is chosen, an automatic charge is attempted on the payment method available if the customer has enabled auto-collection. If a payment collection fails or when auto-collection is not enabled, the invoice is closed as unpaid.
Handles dunning for invoices already in the dunning cycle when a subscription is paused. Applicable when pause_option is set as immediately.
If invoice is in the dunning cycle, invoice_dunning_handing allows you to stop or continue dunning.
Continue dunning
Stop dunning
The number of subscription billing cycles that will be skipped. The subscription resumes after the set number of billing cycles have been skipped. This is applicable only when the value of of pause_option
is billing_cycles
.