ucp_cancel_checkout
DestructiveIdempotent
Cancel a UCP checkout session. Transitions to 'canceled' status. Cannot cancel already completed checkouts. Checkout guide: https://trusteed.xyz/.well-known/agent-checkout-guide.json.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reason | No | Optional cancellation reason | |
| agent_key | No | Sandbox credential from `create_sandbox_key`. Use this when your client cannot set an `Authorization: Bearer` header. | |
| checkout_id | Yes | UCP checkout session ID (valid UUID) | |
| idempotency_key | No | Optional idempotency key to prevent duplicate cancellations. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| label | No | ||
| intent | No | ||
| status | Yes | ||
| totals | Yes | ||
| currency | Yes | ||
| next_step | No | ||
| created_at | Yes | ||
| expires_at | No | ISO-8601 UTC instant at which this checkout SESSION stops being usable. It is not a stock reservation and not a price guarantee. | |
| extensions | No | ||
| line_items | Yes | ||
| updated_at | Yes | ||
| fulfillment | No | ||
| next_action | No | ||
| approval_url | No | ||
| idempotency_key | No | ||
| payment_options | No | ||
| next_step_message | No | ||
| expires_in_seconds | No | Whole seconds left on this checkout SESSION at response time (0 when already past). It is not a stock reservation and not a price guarantee. |