Skip to main content
POST
Start hosted billing checkout
CLI:

Overview

Start hosted billing checkout This page documents post /api/billing/checkout. Use the request and response sections on this page for accepted parameters, payload fields, response fields, and authentication behavior.

AI agent notes

  • Confirm the operation matches the user’s intent before calling it.
  • For write operations, confirm the user intends to change state.
  • Surface validation, permission, and not-found errors instead of retrying unchanged.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
planId
enum<string>
required
Available options:
starter,
pro
returnSurface
enum<string>
required
Available options:
onboarding,
billing
idempotencyKey
string<uuid>
required

Response

Hosted checkout

checkout
object
required
replayed
boolean
required