Create a checkout session

Full description

Create a checkout session for the authenticated customer. Provide at least one selected product in line_items[]. Buyer contact details, context, and payment selection are optional. The response is incomplete until it has purchasable line items and a selected eligible saved payment instrument. For POS and hardware products, use input with a commerce_location type and the required business and store IDs.

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token presented through Authorization: Bearer $GODADDY_PAT. The PAT must include the scope documented for the operation.

In: header

Header Parameters

Request-Id*string

For tracing the request across network layers and components.

Formatuuid

Idempotency-Key*string

Ensures duplicate operations don't happen during retries.

Request Body

application/json

Shared UCP 2026-04-08 writable Checkout fields for create and update requests.

line_items*array<>

List of line items being checked out.

buyer?

Representation of the buyer.

context?

UCP context object carrying locale, market, and buyer location signals for price determination.

signals?

Behavioral and session signals used for offer personalisation and fraud detection.

attribution?

Marketing attribution data tracking the origin of the checkout session.

payment?

Payment method and credential data for completing the purchase.

fulfillment?Fulfillment Extension

Optional physical shipping or pickup fulfillment destination.

[key: string]?any

Response Body

`application/json`

curl -X POST "https://example.com/checkout-sessions" \  -H "Request-Id: 6ba7b810-9dad-41d1-80b4-00c04fd430c8" \  -H "Idempotency-Key: 2f6f5b2b-6764-4a62-93f0-703980f08180" \  -H "Content-Type: application/json" \  -d '{    "line_items": [      {        "item": {          "id": "hosting-deluxeapi:1mo"        },        "quantity": 1      }    ]  }'

{  "ucp": {    "version": "2026-04-08",    "capabilities": {      "dev.ucp.shopping.checkout": [        {          "version": "2026-04-08"        }      ],      "com.godaddy.shopping.input": [        {          "version": "2026-04-08"        }      ],      "com.godaddy.shopping.catalog_offer": [        {          "version": "2026-04-08"        }      ]    },    "payment_handlers": {      "com.godaddy.payments": [        {          "id": "com.godaddy.payments",          "version": "2026-04-08"        }      ]    }  },  "id": "d9cf79e3-b39b-4e58-8f30-ddfe1619e969",  "line_items": [    {      "id": "li_1",      "item": {        "id": "hosting-deluxeapi:1mo",        "title": "Web Hosting Deluxe — 1 Month",        "price": 1099      },      "quantity": 1,      "totals": [        {          "type": "subtotal",          "amount": 1099        },        {          "type": "total",          "amount": 1099        }      ]    }  ],  "status": "incomplete",  "currency": "USD",  "totals": [    {      "type": "subtotal",      "amount": 1099    },    {      "type": "total",      "amount": 1099    }  ],  "links": [    {      "type": "privacy_policy",      "url": "https://www.godaddy.com/legal/agreements/privacy-policy"    },    {      "type": "terms_of_service",      "url": "https://www.godaddy.com/legal/agreements/terms-of-service"    }  ]}

Last updated on

Create a checkout session

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401

403

404application/json

422application/json

429

Web Hosting Deluxe checkout incomplete for a non-payment requirement

Checkout with missing required product configuration

Checkout with a required API Services Purchase Agreement

`application/json`

`application/json`

`application/json`

`application/json`