Skip to main content
POST
Open the billing portal

Authorizations

Authorization
string
header
required

A personal access token (POST /v1/auth/tokens) or a machine identity token (POST /v1/projects/{project_id}/identities/{identity_id}/tokens), both prefixed qumo_pat_. A token's scopes cap what it can do; see Scopes and permissions. A personal token names no organization: on a route whose path names no project or organization, pass ?organization_id=.

Query Parameters

organization_id
string<uuid>

The organization the request acts in. Required with a personal token or a session, which name no organization themselves; an identity token's organization is implied.

Body

application/json
return_url
string<uri>

Where the portal sends the customer back to.

Example:

"https://console.qumo-deploy.com/settings/billing"

flow
enum<string>

Opens the portal on a specific task for the live subscription: subscription_update (change plan) or subscription_cancel. Empty or omitted opens the portal's home page.

Available options:
,
subscription_update,
subscription_cancel
Example:

"subscription_update"

Response

The portal session was created.

url
string<uri>
required

The portal session URL to redirect the customer to.

Example:

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