`cancel_checkout`

Abandon an unfinished checkout.

Anonymous, or a Bearer token for viewer tools

Endpoint

endpoint

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

When to use it

To abandon a checkout the buyer walked away from.
Not to undo a completed purchase — that is a refund, which the business handles.

Parameters

idstringrequired

Checkout session id.

metaobjectoptional

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

Returns

Confirmation. Idempotent, so cancelling an already-cancelled checkout is not an error; a completed one cannot be cancelled.

Example

POST this to the endpoint above.

JSON-RPC

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cancel_checkout",
    "arguments": {
      "id": "checkout_abc123"
    }
  }
}

content

checkout_abc123 · status: cancelled

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.

cancel_checkout

Abandon a checkout session that has not completed. Idempotent; a completed checkout cannot be cancelled (that would be a refund, which the business handles).