HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
API Reference
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo

Cancel a subscription

put
https://v3.recurly.com/subscriptions//cancel

A canceled subscription will continue through its current billing cycle. At the end of the current billing cycle the subscription will expire and the customer will no longer be billed. Canceled subscriptions can be reactivated until the end of the billing cycle. When a future subscription (state=future) is canceled it becomes failed state=failed and cannot be reactivated.

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
string
enum
Defaults to term_end

The timeframe parameter controls when the expiration takes place. The bill_date timeframe causes the subscription to expire when the subscription is scheduled to bill next. The term_end timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.

Allowed:
Responses

Updated 3 months ago

Did this page help you?
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

Updated 3 months ago

Did this page help you?