Sign in
OpenMeter Entitlements

Get customer entitlement value

Changed on

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

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

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/customers/{customerId}/entitlements/{entitlementId}/value
  • Auth: none declared

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

A key is a unique string that is used to identify a resource.

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

{
  "feature_key": "resource_key",
  "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