Skip to main content
GET
Retrieve an order

Authorizations

Authorization
string
header
required

Bearer credential for the public API: a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Dashboard sign-in tokens are not accepted.

Path Parameters

id
string
required

id public identifier.

Pattern: ^ord_[A-Za-z0-9]{8,32}$
Example:

"ord_A1b2C3d4E5f6"

Query Parameters

state
string

Which order states to return: one of draft, pending, succeeded, failed, or several separated by commas (draft,pending,failed). Without it only succeeded orders are returned, exactly as before this parameter existed. Naming it, even as state=succeeded, also adds last_payment_error to each order that has one. An unknown name or an empty element is refused with 422.

Response

Successful response

data
object
required