Start a Stripe Checkout session

POST /v1/me/billing/checkout-session

• Operation ID: createCheckoutSession
• Tags: Billing
• Base URL: http://localhost:8787

Provide productId or priceId; the price and mode are resolved from the catalog (credit packs use one-off payment and accept quantity, plans use subscription with a single seat). Creates the Stripe customer on first use. Redirect the user to the returned url.

Workflow: Integration guide.

Authentication: Platform user Bearer JWT. Acts only on the caller's own data.

Authentication

• Auth: Platform user Bearer JWT (Authorization: Bearer <access_token>).

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
productId	string<uuid>	no	-
priceId	string	no	Min length: 1
successUrl	string<uri>	yes	-
cancelUrl	string<uri>	yes	-
quantity	integer	no	Greater than: 0. Max: 99

Example

{
  "priceId": "price_example",
  "successUrl": "https://portal.example.com/billing?checkout=success",
  "cancelUrl": "https://portal.example.com/billing?checkout=cancelled",
  "quantity": 1
}

Responses

200

Checkout session.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object

Field	Type	Required	Description
url	string | null	yes	Hosted Checkout URL to redirect the user to.
id	string	yes	Stripe Checkout session id.

Example

{
  "url": "https://checkout.stripe.com/example",
  "id": "cs_example"
}

Errors

400

Request validation failed.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

Field	Type	Required	Description
success	boolean	yes	One of: false
error	object	yes	-
error.name	string	yes	One of: "ZodError"
error.issues	object[]	yes	-
error.issues[].code	string	yes	-
error.issues[].path	(string | number)[]	yes	-
error.issues[].message	string	yes	-

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

404

product: no matching catalog product.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "product"
}

422

price_mismatch (priceId does not belong to productId) or product_has_no_price.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "price_mismatch"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

503

Maintenance can refuse this write before authentication (degraded blocks session start and checkout; lockdown blocks other public/user writes).

• Header x-request-id: Request identifier; quote it when reporting an error.
• Header Retry-After: Maintenance retry delay in seconds; present for panic_mode. Example: 30. Content type: application/json

Schema: object (MaintenanceErrorBody)

Field	Type	Required	Description
error	string	yes	One of: "panic_mode"
level	string	yes	One of: "degraded", "lockdown"
reason	string | null	yes	-

Maintenance lockdown

{
  "error": "panic_mode",
  "level": "lockdown",
  "reason": "Scheduled maintenance"
}

Examples

curl

curl -X POST 'http://localhost:8787/v1/me/billing/checkout-session' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"priceId":"price_example","successUrl":"https://portal.example.com/billing?checkout=success","cancelUrl":"https://portal.example.com/billing?checkout=cancelled","quantity":1}'

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/me/billing/checkout-session", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "priceId": "price_example",
    "successUrl": "https://portal.example.com/billing?checkout=success",
    "cancelUrl": "https://portal.example.com/billing?checkout=cancelled",
    "quantity": 1
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();