Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id
string

Filter by customer ID or alias

subscription_id
string<MeteroidId>
Example:

"sub_7n42DGM5Tflk9n8mt7Fhc7"

statuses
enum<string>[]
Available options:
DRAFT,
FINALIZED,
UNCOLLECTIBLE,
VOID
order_by
string

Sort order. Format: column.direction. Allowed columns: invoice_number, customer_name, amount, invoice_date, status, payment_status. Direction: asc or desc. Default: invoice_date.desc.

page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100

Response

List of invoices

data
object[]
required
pagination_meta
object
required