Skip to main content

Cancel Subscription

POST 
/api/v2/subscriptions/:subscription_id/cancel

Schedule or complete cancellation and optionally cancel related invoices.

Behavior depends on subscription status:

  • ACTIVE: Cancellation is scheduled for the end of the current billing period (the subscription stays active until then; it is not moved to CANCELED immediately).
  • INACTIVE, TRIALING, TRIAL_PENDING: The subscription is canceled immediately (status becomes CANCELED).

Use cancel_related_invoices to also cancel ongoing invoices tied to this subscription.

Request​

Responses​

Successful Response