Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Invoice

List invoices

This endpoint returns a list of all Invoices for an account in a list format.

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.

If you don't need line item details, minimums, maximums, or discounts, prefer the list invoices summary endpoint for better performance.

get/invoices

Query parameters

customer_idstring nullable
external_customer_idstring nullable
subscription_idstring nullable
status'draft' | 'issued' | 'paid' | 'synced' | 'void' nullable
status[]string[] nullable
due_date_windowstring nullable

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.

date_type'due_date' | 'invoice_date' nullable
due_datestring date nullable
due_date[gt]string date nullable
due_date[lt]string date nullable
amountstring nullable
amount[gt]string nullable
amount[lt]string nullable
is_recurringboolean nullable
limitinteger

The number of items to fetch. Defaults to 20.

cursorstring nullable

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

invoice_date[gte]string date-time nullable
invoice_date[gt]string date-time nullable
invoice_date[lt]string date-time nullable
invoice_date[lte]string date-time nullable

Response

OK