Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

status
enum<string>

Filter by order status

Available options:
succeeded,
pending,
failed,
refunded,
partially_refunded
customer
string

Filter by customer ID

processor
string

Filter by payment processor

expand
string

Comma-separated relations to expand: customer, line_items

starting_after
string

Cursor for pagination — the ID of the last item in the previous page

limit
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

List of orders

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required