Skip to content

get_checkout

Read a checkout session by id.

Anonymous, or a Bearer token for viewer tools

Endpoint

endpoint
https://go.sessions.website/@<handle>/api/ucp/mcp

When to use it

  • To poll a checkout you created earlier.

  • After complete_checkout, to read the resulting order.

Parameters

idstringrequired

Checkout session id.

metaobjectoptional

Request metadata: {"ucp-agent": "<your platform profile URI>", "idempotency-key": "<uuid>"}.

Returns

The checkout session as it stands: status, totals, messages, and the order once it has completed.

Example

POST this to the endpoint above.

JSON-RPC
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_checkout",
    "arguments": {
      "id": "checkout_abc123"
    }
  }
}
content
checkout_abc123 · status: completed
Order: order_def456

What the agent is told

The description the model reads when deciding whether to call this. It is the only thing that decides whether the tool fires at the right moment, so it is worth knowing what it says.

get_checkout
Fetch a checkout session by id — its current status, totals, messages, and (once complete) the resulting order.

See also