HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
API Reference

Pause Subscription

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Subscription's unique identifier.

Body Params
integer
required

The number of billing cycles that the subscription will be paused

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/xml