Skip to main content
GET
List orders

Authorizations

Authorization
string
header
default:Bearer pk_test_<your-test-key>
required

Partner API key (pk_live_… or pk_test_…).

Query Parameters

customer_id
string

Filter to orders for one customer, by cus_… ID.

Pattern: ^cus_
Example:

"cus_01HZX0C6Z3K4M5N6P7Q8R9S0"

bundle_id
string

Filter by bundle (bun_…).

Example:

"bun_01HZX0BK1A2B3C4D5E6F7G8H"

status
enum<string>

Filter by status.

Available options:
in_progress,
completed,
failed,
action_required,
cancel_scheduled,
cancelled
per_page
integer
default:25

How many rows per page (default 25, max 100).

Required range: 1 <= x <= 100
page_token
string

Opaque cursor from links.next. Pass it through as-is.

Response

A page of orders.

data
object[]
required
meta
object
Last modified on August 25, 2026