List invoices summary
This is a lighter-weight endpoint that returns a list of all Invoice summaries for an account in a list format.
These invoice summaries do not include line item details, minimums, maximums, and discounts, making this endpoint more efficient.
The list of invoices is ordered starting from the most recently issued invoice date. The response also includes pagination_metadata, which lets the caller retrieve the next page of results if they exist.
By default, this only returns invoices that are issued, paid, or synced.
When fetching any draft invoices, this returns the last-computed invoice values for each draft invoice, which may not always be up-to-date since Orb regularly refreshes invoices asynchronously.
Query parameters
Filters invoices by their due dates within a specific time range in the past. Specify the range as a number followed by 'd' (days) or 'm' (months). For example, '7d' filters invoices due in the last 7 days, and '2m' filters those due in the last 2 months.
The number of items to fetch. Defaults to 20.
Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
Response
OK
Example response
{
"data": [
{
"amount_due": "8.00",
"created_at": "2022-05-01T07:01:31+00:00",
"currency": "USD",
"due_date": "2022-05-30T07:00:00+00:00",
"invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
"invoice_number": "JYEFHK-00001",
"subscription": {
"id": "VDGsT23osdLb84KD"
},
"total": "8.00",
"customer_balance_transactions": [
{
"id": "cgZa3SXcsPTVyC4Y",
"created_at": "2022-05-01T07:01:31+00:00",
"starting_balance": "33.00",
"ending_balance": "22.00",
"amount": "11.00",
"description": "An optional description",
"invoice": {
"id": "gXcsPTVyC4YZa3Sc"
}
}
],
"credit_notes": [
{
"voided_at": "2022-05-01T07:01:31+00:00"
}
],
"payment_attempts": [
{
"receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
}
],
"invoice_date": "2022-05-01T07:00:00+00:00"
}
]
}