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/v3/openmeter/billing/invoices

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/billing/invoices
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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": {
    "eq": "2022-03-30T07:20:50Z"
  },
  "service_period_start": {
    "eq": "2022-03-30T07:20:50Z"
  },
  "created_at": {
    "eq": "2022-03-30T07:20:50Z"
  }
}

Response

Page paginated response.

Changes

  • 7aab863a6daaRevision changes
    • breaking

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

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 59663dd13a10Revision changes
    • info

      endpoint added