Documentation menu
Billing

Create checkout session

POST /api/v1/organizations/{organizationIdOrSlug}/billing/checkout

Create a Stripe checkout session for subscription purchase.

Authentication

  • Requires the authenticated user to have billing:manage permission
  • Public API requests use Bearer authentication; Studio uses session authentication

Request

  • planKey: The subscription plan key to purchase
  • successUrl: URL to redirect to on successful checkout
  • cancelUrl: URL to redirect to if checkout is cancelled
  • Idempotency-Key: Printable retry key, scoped to this Organization and user

Response

  • Returns a checkout URL to redirect the user to Stripe
  • Return URLs may point to your own UI; use absolute HTTP or HTTPS URLs without embedded credentials

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to Create checkout session.

header

NameTypeRequiredDescription
Idempotency-Keystringrequired

Request body

Required — Request body for: Create checkout session.

application/json

NameTypeRequiredDescription
planKeystringrequired
successUrlstringrequired
cancelUrlstringrequired

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)