Skip to main content
GET
List Invoices (v1)

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Query Parameters

select_filters
string
required

when (required). Date range in unix seconds (UTC). Operators: gte, gt, lte, lt.

service (optional). Filter by payment service: transfer, stripe_payments, bitpay, coinbase, crypto.com, instance_prepay, paypal_manual, wise_manual. Operators: eq, neq, in, notin.

Examples:

order_by
string

Sort results by column. Columns: paid_on, amount_cents, when. Direction: asc or desc (default desc).

Example: [{"col":"paid_on","dir":"desc"}]

latest_first
boolean
default:true

Sort newest invoices first. If order_by is also set, order_by takes precedence.

Example:

true

limit
integer
default:60

Max results per page.

Required range: x >= 1
Example:

20

after_token
string

Pass the next_token value from the previous response to fetch the next page of results. When the response returns next_token: null, there are no more pages.

Example:

"eyJ2YWx1ZXMiOiB7ImlkIjogMjY3MjU5N30sICJvc19wYWdlIjogMH0="

Response

200 - application/json

Invalid date range or no results: {"success": false, "error": "Invalid date range", ...} or {"success": true, "count": 0, "results": [], ...}

success
boolean

True when request succeeded

count
integer

Number of formatted results returned

total
integer

Total matching invoices

results
object[]

Formatted invoice entries with start, end, type, source, description, amount, metadata, and items fields

next_token
string

Cursor for the next page, or null