Skip to main content
GET
List orders

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.

Query Parameters

created_from
string

Inclusive lower bound on the order's created_at, ISO 8601. A bare date (YYYY-MM-DD) expands to the beginning of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

created_to
string

Inclusive upper bound on the order's created_at, ISO 8601. A bare date (YYYY-MM-DD) expands to the end of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

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.

page
integer

Page number for paginated results. Values below 1 and non-numeric values are ignored and the first page is returned; a page past the last one returns the last page. current_page is accepted as an older name for it and wins when both are sent.

Required range: x >= 1
per_page
integer

Number of records per page. Defaults to 12; values above 25 are clamped to 25; values below 1 and non-numeric values are ignored and the default is used. items and limit are accepted as older names for it, read only when per_page is absent.

Required range: 1 <= x <= 25

Response

Successful response

data
object[]
required
pagination
object
required