Orders/get_checkout
Tool · Orders

get_checkout

Read one of the customer's checkouts: the stored quote (items, totals.today in its currency, messages), its status and, once completed, the order (order_id, invoice_id, status). It does not re-quote; prices are re-checked when completing. Use it after checkout_in_progress, to show a continue_url again (status requires_escalation), or to see whether the customer finished in the browser (status completed). A checkout the customer does not own returns not_found, the same as one that does not exist. Requires the ordering permission (prepare orders) the customer granted.

Read-onlyIdempotentscope write:orders

Invoked over the MCP transport with a tools/call request naming this tool.

Authorization #

Requires a valid OAuth 2.1 bearer access_token whose grant includes the write:orders scope — Prepare orders (hosting, domains) for you to confirm and pay in the client area. The broker resolves the caller from the token and returns only records the account owns.

Parameters #

checkout_idstringRequired
The checkout id returned by create_checkout.

Response #

200 · application/json

idstring
statusstring
One of: incomplete ready requires_escalation completed expired canceled
itemsarray<object>
refstring
typestring
One of: product domain_register domain_transfer
descriptionstring
todaystring
recurringobject
cyclestring
amountstring
renewalstring
premiumobject
is_premiumboolean
renewalstring
serverobject
hostnamestring
ns1prefixstring
ns2prefixstring
rootpw_setboolean
checksarray<object>
codestring
okboolean
messagestring
needs_inputboolean
fieldstring
optionsarray<integer · string>
totalsobject
subtotalstring
discountstring
taxstring
todaystring
currencystring
messagesarray<object>
codestring
severitystring
One of: error needs_input info
fieldstring
textstring
optionsarray<integer · string>
continue_urlstring
expires_atstring
orderobject
order_idinteger
invoice_idinteger
statusstring
One of: Paid Unpaid Cancelled none
payment_methodsarray<object>
idinteger
typestring
brandstring
last4string
expirystring · null
is_defaultboolean
is_expiredboolean
messagestring
paramstring
scopestring
retry_after_secondsinteger

Errors #

ResultWhen
{ "error": "not_found" }The requested item does not exist, or it belongs to another account. Cross-account IDs are indistinguishable from missing ones by design.
{ "error": "backend_unavailable" }See the tool description for when this result is returned.
{ "error": "invalid_params" }See the tool description for when this result is returned.
{ "error": "confirm_required" }The call changes something (places an order, runs a mutating operation) and was made without confirm:true. Show the customer what will happen, get their agreement, then repeat with confirm:true.
{ "error": "checkout_expired" }The checkout passed its expiry time; create a new one — it is quoted afresh.
{ "error": "checkout_not_ready" }The checkout has a failing item check, needs input, or its price changed since it was quoted. The checkout object comes back with the error; fix it with update_checkout (a re-quote clears price_changed), then complete it.
{ "error": "checkout_closed" }The checkout is already completed or canceled; nothing can be changed. Create a new checkout for a new order.
{ "error": "checkout_in_progress" }The checkout is being completed right now (a parallel request or the customer in the client area). Wait, then get_checkout shows the outcome.
{ "error": "idempotency_conflict" }The idempotency_key was already used for a different checkout. Use a new key, or the key that belongs to this checkout to retry it.
{ "error": "pay_not_permitted" }The connection may prepare orders but not pay with the stored card (the pay permission was not granted, or the credential lacks it). Complete with mode "link" and hand over continue_url.
{ "error": "insufficient_scope" }The connection does not include the ordering permission; the customer can reconnect and grant it.
{ "error": "ordering_unavailable" }Ordering through the assistant is switched off (feature switch). The customer orders on the website or through a ticket.
{ "error": "rate_limited" }Too many requests of this kind in a short time; retry_after_seconds says how long to wait. Do not loop.
{ "error": "internal_error" }See the tool description for when this result is returned.