Skip to main content
POST
Create a hosted Checkout session

Authorizations

Authorization
string
header
required

Opaque AMS machine token created by browser-assisted CLI login. Management requests are restricted to that machine profile's workspace and linked human membership.

Headers

Idempotency-Key
string
required

Stable caller-generated key for one logical write. Reuse it only when retrying identical input.

Required string length: 1 - 200

Path Parameters

workspace_id
string<uuid>
required

Exact workspace UUID.

Body

application/json
plan
enum<string>
required
Available options:
pro,
business
interval
enum<string>
required
Available options:
month,
year
business_use_confirmed
boolean
required

Confirms the subscription is for the buyer's trade, profession, or business rather than primarily personal use.

paid_terms_accepted
boolean
required

Confirms explicit acceptance of the current Terms and Billing Terms and acknowledgement of the Privacy Notice.

paid_terms_version
string
required

Exact purchase_terms.version returned by the current workspace billing response.

Required string length: 1 - 100

Response

A hosted Checkout session.

session_id
string
required
url
string<uri>
required