orders

Query

account

Return only orders made from/to account

dateFrom

Only return orders that were created after this date

dateTo

Only return orders that were created after this date

filter

Account orders filter (INCOMING or OUTGOING)

frequency

Use this field to filter orders on their frequency (ONETIME, MONTHLY or YEARLY)

includeHostedAccounts

If account is a host, also include hosted accounts orders

includeIncognito

Whether to include incognito orders. Must be admin or root. Only with filter null or OUTGOING.

limit

The number of results to fetch (default 10, max 1000)

Default: 100

maxAmount

Only return orders where the amount is lower than or equal to this value (in cents)

minAmount

Only return orders where the amount is greater than or equal to this value (in cents)

offset

The offset to use to fetch

onlyActiveSubscriptions

Same as onlySubscriptions, but returns only orders with active subscriptions

onlySubscriptions

Only returns orders that have a subscription (monthly/yearly). Don't use together with frequency.

orderBy

The order of results

Default: { "field": "CREATED_AT", "direction": "DESC" }

paymentMethod

Only return orders that were paid with this payment method. Must be an admin of the account owning the payment method.

searchTerm

The term to search

status

Use this field to filter orders on their statuses