Skip to main content
POST
Cancel the subscription

Authorizations

Authorization
string
header
required

Personal access token (msb_pat_…) or session JWT - the credential an agent acts with on a user's behalf.

Path Parameters

slug
string
required

Organization slug

Response

Cancellation scheduled for period end

Billing summary response for an organization.

effective_pricing
object
required

Effective commercial terms after applying any org-specific agreement.

effective_state
enum<string>
required

Effective billing state derived from plan, period end, and suspension.

Available options:
free,
active,
past_due,
suspended
is_suspended
boolean
required
plan
object
required

Summary of a billing plan (subset of full plan).

available_credit_cents
integer<int64> | null

Positive USD credit Stripe will apply automatically to future invoices.

Required range: x >= 0
billing_terms_override
null | object

Current agreement metadata, including setup and payment-pending states.

checkout_url
string | null

Hosted-checkout URL to complete payment for a just-changed plan (Autumn). Set only on a plan change that needs payment; the client redirects to it.

current_period_ends_at
string<date-time> | null
pending_plan
null | object

Plan the org will switch to at current_period_ends_at, if a downgrade is scheduled.