Search invoices
Search your invoices, both subscription and standalone. Filters combine
with AND, and at least one must be provided (ordering alone is not enough).
Empty arrays are treated as omitted.
To list a customer’s standalone invoices, send customer_id with an explicit
subscription_id: null.
Statuses are the raw invoice statuses the response’s status field
reports. Voided invoices are included in results by default; they are excluded
only when a statuses filter is provided that does not include VOIDED.
Dates. All *_date_min / *_date_max bounds are inclusive and interpreted
in your account’s timezone (_min expands to start of day, _max to end of
day).
issued_date filters on the invoice’s billing-run date and paid_date on when
it was fully paid. A due_date range filters on the due date only — it does
not implicitly exclude paid invoices; combine with statuses to narrow.
Days past due is the number of whole days between the due date and now.
Invoices with no outstanding balance (fully paid, or nothing due) have no
days-past-due value and never match a days_past_due filter. For AR-aging
queries combine with "statuses": ["PAST_DUE"].
Amounts are integer minor currency units (e.g. cents). amount_due is the
remaining unpaid amount; paid_amount is the total paid so far, including
partial payments.
search_term matches invoice numbers, customer names, invoice UUIDs, and
amounts.
Ordering takes a single field name with an optional - prefix for
descending: issued_at, due_at, or amount_due (remaining amount). Defaults
to newest first.
Pagination is handled via query params (limit, offset).
Authorizations
API key for authentication
Query Parameters
Number of results to return per page.
The initial index from which to return the results.
Body
Mixin for validating a seller-supplied metadata input.
Filter invoices by invoice number (e.g. '6c12021a-4')
Filter invoices by invoice ID
Filter invoices by customer ID
Filter invoices by subscription ID. Pass null to match invoices with no subscription. Omit to apply no subscription filter.
Filter invoices by status.
Current status of the invoice. One of:
MUTED— Invoice will not be sent. Muted invoices come from migration cut-overs or from muting invoices in the product settings.SCHEDULED— Scheduled to be issued on a future date.OUTSTANDING— Issued and awaiting payment.DUE— Payment is due.PAST_DUE— Payment is past its due date.PAID— Fully paid.PARTIALLY_PAID— Partially paid, with a remaining balance.ADJUSTED— Adjusted after issuance.CREDITED— Settled by applying credit.UNPAID— Unpaid.PAUSED— Collection is paused.VOIDED— Voided and no longer collectible.
MUTED- MutedSCHEDULED- ScheduledDRAFT- DraftOUTSTANDING- OutstandingDUE- DuePAST_DUE- Past duePAID- PaidPARTIALLY_PAID- Partially PaidADJUSTED- AdjustedCREDITED- CreditedUNPAID- UnpaidPAUSED- PausedVOIDED- Voided
MUTED, SCHEDULED, DRAFT, OUTSTANDING, DUE, PAST_DUE, PAID, PARTIALLY_PAID, ADJUSTED, CREDITED, UNPAID, PAUSED, VOIDED Filter invoices by currency (e.g. USD, EUR)
USD- United States DollarEUR- EurosGBP- Great British PoundAUD- Australian DollarCAD- Canadian DollarINR- Indian Rupee
USD, EUR, GBP, AUD, CAD, INR Filter invoices by metadata. All supplied key/value pairs must be present on the invoice.
Earliest due date (inclusive, start of day in your account's timezone). Filters on due date only — paid invoices are not implicitly excluded; combine with statuses to narrow.
Latest due date (inclusive, end of day in your account's timezone).
Earliest invoice date (inclusive, start of day in your account's timezone). Filters on the invoice's billing-run date — the date the invoice was generated.
Latest invoice date (inclusive, end of day in your account's timezone).
Earliest fully-paid date (inclusive, start of day in your account's timezone).
Latest fully-paid date (inclusive, end of day in your account's timezone).
Minimum days between the due date and now (inclusive). Invoices with no outstanding balance have no days-past-due value and never match this filter.
x >= 0Maximum days between the due date and now (inclusive).
x >= 0Minimum remaining unpaid amount in minor currency units (inclusive).
Maximum remaining unpaid amount in minor currency units (inclusive).
Minimum total paid amount (including partial payments) in minor currency units (inclusive).
Maximum total paid amount (including partial payments) in minor currency units (inclusive).
Free-text search across invoice numbers, customer names, invoice UUIDs, and amounts.
Order results by field, prefixed with '-' for descending. 'amount_due' is the remaining amount. Defaults to newest first.
issued_at- issued_at-issued_at- -issued_atdue_at- due_at-due_at- -due_atamount_due- amount_due-amount_due- -amount_due
issued_at, -issued_at, due_at, -due_at, amount_due, -amount_due