Skip to main content
POST
Start a plan checkout

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
plan_name
enum<string>
default:Pay as you go

The plan to subscribe to. Pay as you go is the only plan sold at checkout, and the default.

Available options:
Pay as you go
Example:

"Pay as you go"

Response

The checkout session was created.

client_secret
string
required

The Checkout Session's client secret, for mounting Stripe's Payment Element.

Example:

"cs_live_a1B2c3D4e5F6g7H8_secret_9iJ0kL1mN2oP3qR4"

publishable_key
string
required

The Stripe publishable key to initialise Stripe.js with.

Example:

"pk_live_51QxR7aLkdIwHu7ixAbCdEfGhIjKlMnOp"