OpenMeter Entitlements

Get customer entitlement value

Changed on

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Get the customer's access through a single entitlement, optionally evaluated at a point in time.

get/v3/openmeter/customers/{customerId}/entitlements/{entitlementId}/value

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/customers/{customerId}/entitlements/{entitlementId}/value
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH
entitlementIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

expandBillingEntitlementAccessExpand[]

Expand computed fields.

Supported values are:

  • value: Expand the balance details of a metered entitlement; it sets the value field.
atstring date-time

RFC3339 formatted date-time string in UTC.

Example:2023-01-01T01:01:01.001Z

The point in time to evaluate the entitlement at. Defaults to the current time.

Response

EntitlementValueResult response.

type'metered' | 'static' | 'boolean' required

The type of the entitlement.

feature_keystring required

The feature key being evaluated.

has_accessboolean required

Whether the customer has access to the feature. Always true for boolean and static entitlements. Depends on balance for metered entitlements.

configstring

Only available for static entitlements. Config is the JSON parsable configuration of the entitlement. Useful to describe per customer configuration.

Example response

{
  "type": "static",
  "feature_key": "available_models",
  "has_access": true,
  "config": "{ \"availableModels\": [\"gpt-5\", \"gpt-4o\"] }",
  "value": {
    "balance": "100",
    "usage": "50",
    "overage": "0",
    "total_available_grant_amount": "100",
    "grant_balances": {
      "additional_property": "1"
    }
  }
}

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