Client area

GET · Products & purchasing

Get one order

Get one order

GET /api/v1/orders/{order}
R Read
Scope read:orders

Description

Returns the order's invoice, paymentUrl and provisioning[] progress. Use the paymentUrl to hand the human a place to pay; use cancel_order to void an unpaid one.

Path parameters

Name Type Description
order required string

Query parameters

Name Type Description
order_id required integer The order id, e.g. from list_orders. Minimum 1.

Responses

The specification does not describe this response body; the note in the rail says what to expect. Every non-2xx response is an RFC 7807 problem with a stable code.

Commonly returned errors

The codes this operation reaches on its own path: the auth stack, its own validation and ownership checks, and the transport. Not a closed set — a shared code from the full registry can still surface. Each links to the code’s own page, the same URL its type dereferences to.

401 No token was presented, or the token is revoked, expired or unknown.
403 The token lacks a required scope, or this account does not own the resource.
404 No such resource for this account.
422 Validation error
429 The rate limit for this token is exhausted. See `Retry-After`.
500 Something went wrong on our side. The failure is logged against `requestId`.
Esc
navigate open Esc close