Skip to main content
GET
Retrieve a checkout

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Path Parameters

sessionId
string
required

The public session_id (not the internal id UUID).

Response

The checkout, with computed amount and related rows.

id
string<uuid>
required

Internal checkout UUID.

org_id
string<uuid>
required
session_id
string
required

Public ID, used in the checkout URL and as the path parameter for every other call on this resource.

idempotency_key
string | null
required
amount_override
number | null
required

Set only if you passed amount or amountOverride at create.

currency
string
required
metadata
object
required
webhook_url
string | null
required
success_url
string | null
required
cancel_url
string | null
required
tax_rate_id
string<uuid> | null
required
supported_networks
string[]
required
expires_at
string<date-time>
required
status
enum<string>
required
Available options:
open,
completed,
expired,
cancelled
created_at
string<date-time>
required
updated_at
string<date-time>
required
seller_mode
enum<string>
required
Available options:
mor,
crypto
environment
enum<string>
required
Available options:
test,
live
checkoutUrl
string
required

Send your buyer here. Computed, camelCase.

amount
number | null
required

Computed effective price: amount_override, else the linked payment link's amount.

transactions
object[]
required
invoices
object[]
required
invoiceId
string<uuid> | null

Set once an invoice has been issued for this session; null until then.

invoiceNumber
string | null