OPopenmeter
Entitlements

Get entitlement by ID

Get entitlement by ID.

get/api/v2/entitlements/{entitlementId}

Request

  • Base URL
    https://openmeter.cloud (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __session

Path parameters

entitlementIdstring required
Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

The request has succeeded.

OR
OR

Example response

{
  "activeFrom": "2023-01-01T01:01:01.001Z",
  "activeTo": "2023-01-01T01:01:01.001Z",
  "annotations": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "createdAt": "2024-01-01T01:01:01.001Z",
  "currentUsagePeriod": {
    "from": "2023-01-01T01:01:01.001Z",
    "to": "2023-02-01T01:01:01.001Z"
  },
  "customerId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerKey": "customer-1",
  "deletedAt": "2024-01-01T01:01:01.001Z",
  "featureId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "featureKey": "example-feature-key",
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "lastReset": "2023-01-01T01:01:01.001Z",
  "measureUsageFrom": "2023-01-01T01:01:01.001Z",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "updatedAt": "2024-01-01T01:01:01.001Z",
  "usagePeriod": {
    "anchor": "2023-01-01T01:01:01.001Z",
    "interval": "DAY",
    "intervalISO": "P1D"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.