HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
API Reference

Pause subscription

This will put a subscription into the pause state at the next renewal. The body
of the request must contain the remaining_pause_cycles parameter. If the
subscription is currently paused and remaining_pause_cycles is 0, the subscription
will be resumed.

Expired, cancelled, or failed subscriptions cannot be paused.

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

Subscription ID or UUID. For ID no prefix is used e.g. e28zov4fw0v2. For UUID use prefix uuid-, e.g. uuid-123457890.

Body Params
integer
required

Number of billing cycles to pause the subscriptions. A value of 0 will cancel any pending pauses on the subscription.

Responses

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