Skip to main content
POST
Open Billing Portal

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

Request to open the Stripe customer billing portal.

return_url
string | null
default:https://studio.mixpeek.com/billing

URL Stripe redirects back to when the customer leaves the portal

Response

Successful Response

Response with the Stripe-hosted billing portal URL.

The portal lets an existing customer update their card, view invoices, and change or cancel their subscription — distinct from /subscribe, which starts a NEW checkout (re-running checkout for an existing subscriber is wrong).

portal_url
string
required

Stripe-hosted billing portal URL (redirect the user here)

Example:

"https://billing.stripe.com/p/session/live_abc123"

session_id
string
required

Stripe billing portal session ID

Example:

"bps_live_abc123"