Cancel a checkout session

DELETE/ucp/checkout-sessions/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Bearer token obtained from the OAuth authorization server discovered at ucp.oauth.metadata_url in the profile response (GET /.well-known/ucp). Token enforcement may happen at a gateway layer in front of this API.

Path parameters

idstringrequired

Checkout session id, as returned in id / links.self from the create response.

Responses

204

Session cancelled, no content returned

404

No checkout session exists with the given id

ucpUcpEnveloperequired

Protocol version and capability envelope included in every UCP response.

Show properties

versionstringrequired

capabilitiesobjectrequired

Show properties

checkoutstring

messagesMessage[]required

Show properties

Array of Message

typestringrequired

Allowed:infoerrorwarning

codestringrequired

contentstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*Checkout session id, as returned in `id` / `links.self` from the create response.

Request

curl -X DELETE '/ucp/checkout-sessions/string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("/ucp/checkout-sessions/string", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.delete(
    "/ucp/checkout-sessions/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

Response

Session cancelled, no content returned

{
  "ucp": {
    "version": "2026-04-08",
    "capabilities": {
      "checkout": "1.0"
    }
  },
  "messages": [
    {
      "type": "info",
      "code": "string",
      "content": "string"
    }
  ]
}