UCP discovery profile

Advertises this shop’s UCP capabilities, the checkout service endpoint, and where to discover the OAuth authorization server metadata for obtaining a bearer token.

GET/.well-known/ucp

Responses

200

UCP profile for this shop

ucp.versionstringrequired

ucp.servicesobject[]required

Show properties

Array of object

idstringrequired

transportstringrequired

endpointstring<uri>required

ucp.capabilitiesobjectrequired

Show properties

checkoutstring[]

ucp.oauthobjectrequired

Show properties

metadata_urlstring<uri>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Request

curl -X GET '/.well-known/ucp' \
  -H 'Accept: application/json'

const response = await fetch("/.well-known/ucp", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/.well-known/ucp",
    headers={
        "Accept": "application/json"
    },
)

Response

{
  "ucp.version": "2026-04-08",
  "ucp.services": [
    {
      "id": "checkout",
      "transport": "rest",
      "endpoint": "https://myshop.example.com/ucp/checkout-sessions"
    }
  ],
  "ucp.capabilities": {
    "checkout": [
      "1.0"
    ]
  },
  "ucp.oauth": {
    "metadata_url": "https://auth.onbolder.com/.well-known/oauth-authorization-server"
  }
}