Sign in
OpenMeter Entitlements

List entitlements

Changed on

List the active entitlements of all customers. Intended for administrative use. To list the entitlements of a single customer, use the customer entitlements endpoints; to check entitlement access, use the entitlement access endpoints.

get/openmeter/entitlements

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/entitlements
  • Auth: none declared

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

  • created_at (default)
  • updated_at

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

Filter entitlements returned in the response.

To filter entitlements by customer, add the following query param: filter[customer_id]=01K4WAQ0J99ZZ0MD75HXR112H8

{
  "feature_id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "customer_id": "01G65Z755AFWAKHE12NY0CQ9FH"
}

Response

Page paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "feature": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "customer": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "labels": {
        "env": "test"
      },
      "active_from": "2023-01-01T01:01:01.001Z",
      "active_to": "2023-01-01T01:01:01.001Z",
      "created_at": "2023-01-01T01:01:01.001Z",
      "updated_at": "2023-01-01T01:01:01.001Z",
      "deleted_at": "2023-01-01T01:01:01.001Z",
      "usage_period": {
        "anchor": "2023-01-01T01:01:01.001Z",
        "interval": "P1Y"
      },
      "current_usage_period": {
        "from": "2023-01-01T01:01:01.001Z",
        "to": "2023-01-01T01:01:01.001Z"
      },
      "measure_usage_from": "2023-01-01T01:01:01.001Z",
      "last_reset": "2023-01-01T01:01:01.001Z"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes