Skip to main content
POST
Create a hosted checkout session

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito).

Headers

Idempotency-Key
string

Reuse for retries of the same checkout creation.

Maximum string length: 255

Body

application/json
usd
string
required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
successUrl
string<uri>
required
Maximum string length: 2048
cancelUrl
string<uri>
required
Maximum string length: 2048
credits
string

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Pattern: ^\d+(?:\.\d{1,6})?$
externalUserId
string

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$
metadata
object

Serialized object is limited to 500 characters.

Response

Checkout session

success
boolean
required
sessionId
string
required
Pattern: ^cs_
url
string<uri>
required
externalUserId
string | null
required
quote
object
required
bonus
object

Present only when this checkout session will mint a volume bonus on completion (tenant pool top-up reaching a tier).