OpenMeter Entitlements

Get customer entitlement access

Changed on

Get the customer's access to a single feature.

get/openmeter/customers/{customerId}/entitlement-access/features/{featureKey}

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/customers/{customerId}/entitlement-access/features/{featureKey}
  • Auth: none declared

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH
featureKeystring required

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

Example:resource_key

Response

EntitlementAccessCheckResult response.

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.

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

The type of the entitlement.

Example response

{
  "has_access": true,
  "config": "{ \"availableModels\": [\"gpt-5\", \"gpt-4o\"] }"
}

Changes

    • ▲

      the response property became optional for the status

    • ▲

      removed the required property from the response with the status

    • ●

      deleted the query request parameter expand

    • ●

      removed the optional property from the response with the status

    • ○

      endpoint added