Schedule a pause or update remaining pause cycles for a subscription.
Use this endpoint to:
- Schedule a subscription pause on an active subscription
- Update the pause period length on a subscription with a scheduled pause or a subscription paused already.
- Cancel a scheduled pause on a pending pause subscription
For an active subscription without a pause scheduled already, this will schedule a pause period to begin at the next bill date for the specified number of billing cycles (remaining_pause_cycles).
When a scheduled pause already exists, this will update the remaining pause cycles with the new value sent. When zero (0) remaining_pause_cycles is sent for a subscription with a scheduled pause, the pause will be canceled.
For a paused subscription, the remaining_pause_cycles will adjust the length of the current pause period. Sending zero (0) in the remaining_pause_cycles field will cause the subscription to be resumed at the next bill date.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||