List billing invoices
List billing invoices.
Returns a page of invoices. Gathering invoices are never included. Use filter to narrow by status, customer, dates, or service period start. Use sort to control ordering.
Query parameters
Determines which page of the collection to retrieve.
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').
Sort invoices returned in the response. Supported sort attributes:
- issued_at
- created_at (default)
- service_period_start
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.
Filter invoices returned in the response.
Examples:
- filter[status][oeq]=draft,issued
- filter[customer_id]=01KPDB8K...
- filter[issued_at][gte]=2024-01-01T00:00:00Z
{
"customer_id": "01G65Z755AFWAKHE12NY0CQ9FH",
"issued_at": "2023-01-01T01:01:01.001Z",
"service_period_start": "2023-01-01T01:01:01.001Z",
"created_at": "2023-01-01T01:01:01.001Z"
}Response
Page paginated response.