List Orders
Retrieve a list of all orders with optional filtering
GET
List Orders
List Orders
Returns a paginated list of orders, ordered by creation date (most recent first). Supports filtering by status, customer, payment status, and date range.Authentication
Query Parameters
| Parameter | Type | Description |
|---|---|---|
limit | integer | Number of results per page (default: 10, max: 100) |
starting_after | string | Cursor for pagination (order ID) |
status | enum | Filter by status: pending, processing, completed, failed, cancelled |
payment_status | enum | Filter by payment status: pending, authorized, captured, failed, refunded, disputed |
customer_email | string | Filter by customer email |
created_after | timestamp | Filter orders created after this date |
created_before | timestamp | Filter orders created before this date |
Request
Response
All monetary amounts are integers in cents (e.g., 4995 = $49.95).
Response Fields
| Field | Type | Description |
|---|---|---|
data | array | Array of order objects |
has_more | boolean | Whether more results are available |
next_cursor | string | Cursor for next page (use as starting_after) |
Examples
List All Orders
Filter by Status
Filter by Payment Status
Filter by Customer
Errors
| Status Code | Error Code | Description |
|---|---|---|
| 400 | invalid_request | Invalid query parameters |
| 401 | unauthorized | Invalid or missing API key |
| 429 | rate_limit_exceeded | Too many requests |
Related
List Orders
