Checkout

Create a checkout session

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"    }  ]}

Get a checkout session

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

Path Parameters

id*string

The unique identifier of the checkout session.

Header Parameters

Request-Id*string

For tracing the request across network layers and components.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/checkout-sessions/string" \  -H "Request-Id: 6ba7b810-9dad-41d1-80b4-00c04fd430c8"

{  "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": "ready_for_complete",  "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"    }  ],  "payment": {    "instruments": [      {        "id": "profile_visa",        "handler_id": "com.godaddy.payments",        "type": "card",        "selected": true,        "display": {          "brand": "visa",          "last_digits": "4242"        }      },      {        "id": "profile_mastercard",        "handler_id": "com.godaddy.payments",        "type": "card",        "selected": false,        "display": {          "brand": "mastercard",          "last_digits": "4444"        }      }    ]  }}

Update a checkout session

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

Path Parameters

id*string

The unique identifier of the checkout session.

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 PUT "https://example.com/checkout-sessions/string" \  -H "Request-Id: 6ba7b810-9dad-41d1-80b4-00c04fd430c8" \  -H "Idempotency-Key: 2f6f5b2b-6764-4a62-93f0-703980f08180" \  -H "Content-Type: application/json" \  -d '{    "line_items": [      {        "id": "li_hosting_1",        "item": {          "id": "hosting-deluxeapi:1mo"        },        "quantity": 1      }    ],    "payment": {      "instruments": [        {          "id": "profile_mastercard",          "handler_id": "com.godaddy.payments",          "type": "card",          "selected": true        }      ]    }  }'

{  "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": "ready_for_complete",  "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"    }  ],  "payment": {    "instruments": [      {        "id": "profile_visa",        "handler_id": "com.godaddy.payments",        "type": "card",        "selected": true,        "display": {          "brand": "visa",          "last_digits": "4242"        }      },      {        "id": "profile_mastercard",        "handler_id": "com.godaddy.payments",        "type": "card",        "selected": false,        "display": {          "brand": "mastercard",          "last_digits": "4444"        }      }    ]  }}

Complete a checkout session

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

Path Parameters

id*string

The unique identifier of the checkout session.

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

signals?

Behavioral and session signals supplied at completion time.

attribution?

Marketing attribution data for the completed purchase.

payment*

Payment credential required to complete the checkout.

consent?

Acceptance record for agreements declared in checkout.required_agreements.

[key: string]?any

Response Body

`application/json`

curl -X POST "https://example.com/checkout-sessions/string/complete" \  -H "Request-Id: 6ba7b810-9dad-41d1-80b4-00c04fd430c8" \  -H "Idempotency-Key: 2f6f5b2b-6764-4a62-93f0-703980f08180" \  -H "Content-Type: application/json" \  -d '{    "payment": {      "instruments": [        {          "id": "profile_visa",          "handler_id": "com.godaddy.payments",          "type": "card",          "selected": true        }      ]    },    "consent": {      "agreement_types": [        "api_services_purchase_agreement"      ],      "agreed_at": "2026-09-14T20:00:00Z"    }  }'

{  "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": "completed",  "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"    }  ],  "order": {    "id": "2211390786",    "permalink_url": "https://account.godaddy.com/receipts/view/2211390786"  }}

Last updated on

Checkout

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

200application/json

400application/json

401

403

404application/json

422application/json

429

200application/json

400application/json

401

403

404application/json

422application/json

429

Web Hosting Deluxe checkout ready to complete with the first eligible payment profile selected

Checkout ready to complete with a dynamically computed discount

One submitted item could not be priced and was removed

200application/json

400application/json

401

403

404application/json

422application/json

429

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`