billing

Cancel the subscription

Changed on

Cancellation takes effect at the end of the billing period.

post/v1/orgs/{slug}/billing/cancel

Request

  • Base URL
    https://api.microsandbox.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://api.microsandbox.dev/v1/orgs/{slug}/billing/cancel
  • Auth
    HTTP bearer

Path parameters

slugstring required

Organization slug

Response

Cancellation scheduled for period end

available_credit_centsinteger nullable

Positive USD credit Stripe will apply automatically to future invoices.

checkout_urlstring nullable

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_atstring date-time nullable
effective_state'free' | 'active' | 'past_due' | 'suspended' required

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

is_suspendedboolean required

Changes