Skip to main content
GET
Get UCP Checkout Session

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Headers

UCP-Agent
string
required

UCP agent identity, for example agent.example/1.0.

Maximum string length: 240

Path Parameters

sessionId
string
required

Query Parameters

organizationId
string

Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.

Maximum string length: 120

Response

UCP checkout session found.

ucp
object
required
id
string
required
line_items
object[]
required
status
enum<string>
required
Available options:
ready_for_complete,
completed,
canceled
currency
string
required
totals
object[]
required
buyer
object
fulfillment
object
payment
object
order
object
settlement
object