Skip to main content
GET
List invoices

Authorizations

x-api-key
string
header
required

API key for merchant authentication

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
limit
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
merchantId
string

Merchant ID to filter by (defaults to authenticated merchant if not provided)

Pattern: ^[a-f\d]{24}$
status
enum<string>

Filter by invoice status

Available options:
pending,
paid,
cancelled,
refunded,
failed
dateFrom
string<date-time>

Filter invoices created from this date (ISO 8601 datetime)

dateTo
string<date-time>

Filter invoices created until this date (ISO 8601 datetime)

sort
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Invoices retrieved successfully

Paginated response containing invoices (metadata field excluded)

data
object[]
required

Array of invoices (metadata field excluded)

currentPage
integer
required

Current page number

Example:

1

totalPages
integer
required

Total number of pages

Example:

5

totalCount
integer
required

Total number of invoices matching the filter

Example:

47

limit
integer
required

Number of items per page

Example:

10