Skip to main content
POST
Cancel Subscription

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

Body

application/json

Options for subscription cancellation.

immediate
boolean
default:false

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

invoice_now
boolean
default:false

With immediate=true: generate a final proration invoice.

Response

Successful Response

Response after cancelling a subscription.

subscription_id
string
required
cancel_at_period_end
boolean
default:true
status
string | null
message
string
default:Subscription will cancel at end of current billing period