OpenMeter Billing Settings

List billing invoices

Changed on

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.

get/openmeter/billing/invoices

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/billing/invoices
  • Auth: none declared

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

sortstring

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').

Example:created_at 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.

Changes

  • v3159bfd1e78cfRevision changes
    • info

      added to the ///////////////// response property allOf list for the response status

    • info

      removed from the ///////////////// response property allOf list for the response status

  • v39082b60c6dd4Revision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added to the //////// response property allOf list for the response status

    • info

      removed from the //////// response property allOf list for the response status