v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Billing

List invoices

Returns a paginated list of invoices. The list excludes draft invoices that belong to a subscription, and (unless filtered by bulk) invoices attached to a bulk in pending, processing or failed status.

get/invoices/

Query parameters

pageinteger

Page number to retrieve (1-indexed).

page_sizeinteger

Number of items per page.

orderingstring

Field to sort results by. Prefix with - for descending order (e.g. -created).

customerstring

numberinteger

documentinteger

datestring date

Use lookups: date__gte, date__lte.

due_datestring date

collection_method'deferred' | 'deferred_dues' | 'automatically'

subscriptioninteger

bulkinteger

importedboolean

tax_agencystring

totalnumber

total_adjustednumber

createdstring date-time

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Response

Paginated invoice list.

countinteger required

Total number of items matching the filter.

nextstring uri nullable

URL of the next page, or null if last page.

previousstring uri nullable

URL of the previous page, or null if first page.

Example response

{
  "count": 142,
  "results": [
    {
      "id": "inv_01H8XYZ123ABC"
    }
  ]
}