Pause and resume take effect at the moment of the request. Pause with Pause subscription and resume with Resume subscription. For how prorated amounts are calculated, see Understanding Proration.
Pausing a subscription
Only anactive subscription can be paused.
In the dashboard, subscriptions are called contracts. Pause contract is not offered for inherited or grouped-invoicing contracts, or contracts with a cancellation scheduled. To pause an inherited or grouped-invoicing contract, open its parent contract instead. Actions that change a contract require write access to subscriptions.
- Dashboard
- API
1
Open the subscription
Go to Customers, select the customer, and find the active contract in the Contracts card.
2
Choose Pause contract
Open the ⋯ menu beside the contract and select Pause contract. You can also open the contract and use its header menu.
3
Choose the proration behavior
Turn on Credit the unused part of this period to send
proration_behavior: create_prorations. Leave it off (the default) to send none. Optionally enter a Reason (optional).4
Confirm
Click Pause contract. After a successful pause, the contract status changes to Paused.
A paused subscription can be cancelled only with
cancellation_type: immediate. The cancellation bills nothing.Invoicing the period up to the pause
Pausing raises aPRORATION invoice from current_period_start up to the pause. It bills the usage and the ARREAR fixed charges for that time. ADVANCE fixed charges were billed when the period started, so they are not billed again.
The
proration_behavior you send with the pause applies only to this invoice. The subscription’s own proration_behavior does not change.
Resuming a subscription
- Dashboard
- API
1
Open the subscription
Go to Customers, select the customer, and find the paused contract in the Contracts card.
2
Choose Resume contract
Open the ⋯ menu beside the contract and select Resume contract. You can also open the contract and use its header menu.
3
Choose the proration behavior
Turn on Charge for the rest of this period to send
proration_behavior: create_prorations. Leave it off (the default) to send none. The dashboard always sends this choice rather than keeping the subscription’s current setting.4
Confirm
Click Resume contract. After a successful resume, the contract status changes to Active.
Unlike the pause, the
proration_behavior you send with the resume is saved on the subscription, and its later invoices use it.Invoicing the period after the resume
The subscription resumes inside the billing period the resume falls in, and that period still ends on its usual date. Two invoices bill it:SUBSCRIPTION_RESUME, raised at the resume. It bills theADVANCEfixed charges for the rest of the period.SUBSCRIPTION_CYCLE, raised when the period ends. It bills theARREARfixed charges and the usage from the resume onward, and the next period’sADVANCEfixed charges.
proration_behavior decides how much of each fixed charge they bill. When the request omits it, the subscription’s current proration_behavior applies.
Use case: pause in January, resume in March
Webhooks
Understanding Proration
How prorated amounts are calculated.
Pause subscription
API reference for pausing a subscription.
Resume subscription
API reference for resuming a paused subscription.

