Skip to main content

Cancel Subscription

POST/subscriptions//cancel
Cancels a customer subscription. You can cancel immediately (access revoked right away) or at the end of the current billing period (customer retains access until the period ends).

Authentication

Headers

Path Parameters

Request Body

Example Request

Success Response

Returns the full subscription object in the standard SubscriptionResource shape — identical to Get Subscription, List Subscriptions, and Lookup Subscriptions. The fields most relevant to cancellation are shown below — see Get Subscription for the complete field list.

Behavior Options

When using end_of_period, the subscription status stays active and cancel_at_period_end is set to true. The subscription will transition to expired when the period ends.
Immediate cancellation cannot be undone. The customer would need to create a new subscription. Consider using end_of_period to give the customer the full value of their current billing period.

Error Responses