List Orders

string uuid4

The organization ID.

OR

string[]

Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The product ID.

OR

string[]

Filter by product ID.

'one_time' | 'recurring'

OR

ProductBillingType[]

Filter by product billing type. recurring will filter data corresponding to subscriptions creations or renewals. one_time will filter data corresponding to one-time purchases.

string uuid4

OR

string[]

Filter by discount ID.

string uuid4

The customer ID.

OR

string[]

Filter by customer ID.

string

The customer external ID.

OR

string[]

Filter by customer external ID.

string uuid4

OR

string[]

Filter by checkout ID.

string uuid4

The subscription ID.

OR

string[]

Filter by subscription ID.

OR

OrderStatus[]

Filter by order status.

created_afterstring date-time nullable

Only include orders created after this date

created_beforestring date-time nullable

Only include orders created before this date

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingOrderSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

metadataMetadataQuery nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

77e4ef94fcc3

Query parameters

Response