The organization ID

Filter the list of orders by attribute(s).

Exact match:

Include the attribute name in the brackets followed by an equal sign and the value you want to filter by. You can use commas (,) to separate multiple values for the same attribute.

• Allowed attributes: id, currency, status, customer.id

• Example: ?filter[status]=PAST_DUE

• Example (multiple values): ?filter[status]=PAST_DUE,PAID

• Example (null status): ?filter[status]=null (returns orders with no status set)

Partial match:

Include the attribute name in the brackets followed by an equal sign and the value you want to filter by.

• Allowed attributes: name, description, customer.email, customer.firstName, customer.lastName, customer.phone, customer.name

• Example: ?filter[customer.email][email protected] (returns all customer emails containing @example.com)

• Example: ?filter[customer.name]=jane smith (fuzzy full-name search: each word is matched as a partial against either the first or last name, in any word order — e.g. smith, jan smi, or smith jane all match "Jane Smith")

• Example: ?filter[description]=invoice (returns all orders with descriptions containing invoice)

• Example: ?filter[name]=haircut (returns all orders with names containing haircut)

Dynamic operators:

Follow the "=" with a comparison operator and the value you want to filter by.

• Available operators: =, !=, <, <=, >, >=.

• Allowed attributes: amount, createdAt, updatedAt, dueDate

• Example (greater than or equal to): ?filter[amount]=>=500

• Example (less than): ?filter[createdAt]=<2025-05-29T00:00:00Z

• Example (due date filter): ?filter[dueDate]=>=2025-06-01

Scopes:

Filter by specific conditions defined in the model.

• Allowed scopes: createdBetween, updatedBetween, type, pastDue

• Example: ?filter[createdBetween]=2025-05-29,2025-05-30

• Example: ?filter[type]=SUBSCRIPTION (filter by order type: UNSCHEDULED, SUBSCRIPTION, or PAYMENT_PLAN)

• Example: ?filter[pastDue]=true (to filter orders that are past due)

Tags:

Filter by user-applied tags. Use a leading ! to exclude a tag.

• Example: ?filter[tag]=needs-review,priority
• Example: ?filter[tag]=!archived
• Example: ?filter[tag]=needs-review,!archived

Sort the list by attribute(s). Use - prefix for descending order.

• Allowed attributes: name, amount, createdAt, updatedAt, dueDate

• Example (ascending order): ?sort=createdAt

• Example (descending order): ?sort=-amount

The timezone to use for date filtering. Defaults to 'UTC'. Supports timezone identifiers (e.g., America/Phoenix, America/Los_Angeles) and abbreviations (e.g., MST, MDT, PST, PDT). Examples: ?timezone=America/Phoenix or ?timezone=MST