GoDaddy
Support
API ReferenceShoppingShopping APICheckoutComplete a checkout session POST

Complete a checkout session

View as Markdown

Complete a ready checkout session and create its order.

Full description

Complete a ready checkout session and create its order. payment is required. The successful response includes an order ID and receipt URL; use GET /orders/{id} to retrieve full order details. If the checkout response includes required_agreements, include each required key in consent.agreement_types with its acceptance timestamp. Missing or incomplete consent returns a 400 validation error.

POST
/checkout-sessions/{id}/complete

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

Response Body

application/json

application/json

application/json

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

How is this guide?