OpenMeter Entitlements

List customer entitlement grants

Changed on

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

List the grants issued for an entitlement of the customer. Grants only exist for metered entitlements, so the list is empty for boolean and static entitlements.

Deleted grants are excluded unless include_deleted is set. Voided and expired grants are always included, as they are part of the balance history.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/customers/{customerId}/entitlements/{entitlementId}/grants
  • 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

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 grants returned in the response. Supported sort attributes are:

  • created_at (default)
  • updated_at
  • effective_at
  • expires_at

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.

include_deletedboolean

Include deleted grants in the response.

Response

Page paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "entitlement_id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "customer_id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "amount": "100",
      "priority": 1,
      "effective_at": "2023-01-01T01:01:01.001Z",
      "expires_after": "P1M",
      "expires_at": "2023-02-01T01:01:01.001Z",
      "max_rollover_amount": "100",
      "min_rollover_amount": "0",
      "recurrence": {
        "anchor": "2023-01-01T01:01:01.001Z",
        "interval": "P1M"
      },
      "next_recurrence": "2023-02-01T01:01:01.001Z",
      "voided_at": "2023-01-15T01:01:01.001Z",
      "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"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

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