OpenMeter Entitlements

Query entitlement access

Changed on

Query feature access for a list of customers.

The endpoint resolves each provided identifier to a customer and returns the access status for the requested features, plus optional credit balance availability.

Designed to be called on a fixed refresh interval and the query response is intended to be cached.

post/v3/openmeter/entitlement-access/query

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/entitlement-access/query
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

sizeinteger

The number of items to include per page.

afterstring

Request the next page of data, starting with the item after this parameter.

beforestring

Request the previous page of data, starting with the item before this parameter.

Request body

include_creditsboolean

Whether to include credit balance availability for each resolved customer. When true, each feature evaluation includes credit balance checks.

Defaults to false.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "customer": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH",
        "labels": {
          "env": "test"
        },
        "created_at": "2023-01-01T01:01:01.001Z",
        "updated_at": "2023-01-01T01:01:01.001Z",
        "deleted_at": "2023-01-01T01:01:01.001Z",
        "key": "019ae40f-4258-7f15-9491-842f42a7d6ac",
        "currency": "USD",
        "billing_address": {
          "country": "US"
        }
      },
      "updated_at": "2023-01-01T01:01:01.001Z"
    }
  ],
  "meta": {
    "page": {
      "size": 10
    }
  }
}

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