v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Organization Billing

Cancel Subscription

Cancel the current subscription.

Default: cancel at end of billing period (the subscription remains active until then, after which the organization downgrades). With immediate=true (BACKE-2859): cancel NOW — the org-deletion cascade and teardown callers need a cancel that actually ends billing today instead of leaving a live sub on the card.

post/v1/organizations/billing/subscription/cancel

Request body

immediateboolean

Cancel NOW (Stripe Subscription.cancel) instead of at period end. Default False preserves the period-end behavior.

invoice_nowboolean

With immediate=true: generate a final proration invoice.

Response

Successful Response

subscription_idstring required

cancel_at_period_endboolean

statusstring nullable

messagestring