Skip to main content
GET
Invoices

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Query Parameters

page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
page_size
integer
default:50

Items per page. Default 50, max 100.

Required range: 1 <= x <= 100
public_id
string
Maximum string length: 32
status
enum<string>
Available options:
paid,
new,
processing,
cancelled
of_account_id
integer
from
string<date>

Lower bound on the resource date (YYYY-MM-DD, UTC, inclusive).

to
string<date>

Upper bound on the resource date (YYYY-MM-DD, UTC, inclusive).

sort
enum<string>
default:date_desc

Sort order.

  • date_desc: newest invoices first (default).
  • date_asc: oldest invoices first.
  • amount_desc: largest amount first.
  • amount_asc: smallest amount first.
Available options:
date_desc,
date_asc,
amount_desc,
amount_asc

Response

Successful response

success
boolean
Example:

true

data
object[]
pagination
object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.