Skip to main content
GET
List invoices for a merchant

Authorizations

Authorization
string
header
required

Merchant API key bearer token.

Query Parameters

end
string

Inclusive ISO-8601 upper bound for invoice createdAt. Must be >= start when both are provided.

Example:

"2026-03-31T23:59:59.999Z"

start
string

Inclusive ISO-8601 lower bound for invoice createdAt.

Example:

"2026-03-01T00:00:00.000Z"

cursor
string

Opaque cursor from a previous page.nextCursor.

Example:

"eyJ2IjoxLCJkYXRhIjp7ImNyZWF0ZWRBdCI6IjIwMjYtMDMtMDFUMTI6MDA6MDAuMDAwWiIsImlkIjoiaW52XzAxLi4uIn19"

limit
number

Number of items to return. Maximum 100.

Example:

25

status
enum<string>

Optional invoice status filter.

Available options:
draft,
issued,
partially_paid,
paid,
void
customerId
string

Optional customer TypeID (cust_...) filter.

Example:

"cust_01hxy8m1nqk9g3x3y3p0azq2zz"

merchantId
string
required

Merchant TypeID (mer_...) to scope invoice listing.

Example:

"mer_01hxy8m1nqk9g3x3y3p0azq2bg"

Response

Paginated list of invoices. Each item contains invoice number, status, and computed totals.

items
object[]
required
page
object
required