Terminate a subscription

delete

https://v3.recurly.com/subscriptions/{subscription_id}

Immediately expires the subscription.

If the subscription has a paid invoice you may choose to refund all, part or none of last invoice's amount.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscription_id

string

required

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

Query Params

refund

string

enum

Defaults to none

The type of refund to perform:

full - Performs a full refund of the last invoice for the current subscription term.
partial - Prorates a refund based on the amount of time remaining in the current bill cycle.
none - Terminates the subscription without a refund.

In the event that the most recent invoice is a $0 invoice paid entirely by credit, Recurly will apply the credit back to the customer’s account.

You may also terminate a subscription with no refund and then manually refund specific invoices.

Allowed:

charge

boolean

Defaults to true

Applicable only if the subscription has usage based add-ons and unbilled usage logged for the current billing cycle. If true, current billing cycle unbilled usage is billed on the final invoice. If false, Recurly will create a negative usage record for current billing cycle usage that will zero out the final invoice line items.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200An expired subscription.

404Incorrect site ID or subscription ID.

422A validation error such as "Cannot expire an inactive subscription." or "Please provide valid values for these parameters: refund."

defaultUnexpected error.