Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Entitlements

Override customer entitlement

Overriding an entitlement creates a new entitlement from the provided inputs and soft deletes the previous entitlement for the provided customer-feature pair. If the previous entitlement is already deleted or otherwise doesnt exist, the override will fail.

This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.

put/api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/override

Path parameters

string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH
string required

ULID (Universally Unique Lexicographically Sortable Identifier).

OR
string required

ExternalKey is a looser version of key.

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

OR
OR

Example request

{
  "featureKey": "example-feature-key",
  "featureId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "usagePeriod": {
    "interval": "DAY",
    "anchor": "2023-01-01T01:01:01.001Z"
  },
  "measureUsageFrom": "2023-01-01T01:01:01.001Z",
  "grants": [
    {
      "amount": 100,
      "priority": 1,
      "effectiveAt": "2023-01-01T01:01:01.001Z",
      "minRolloverAmount": 100,
      "metadata": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "recurrence": {
        "interval": "DAY",
        "anchor": "2023-01-01T01:01:01.001Z"
      },
      "maxRolloverAmount": 100,
      "expiration": {
        "count": 12
      },
      "annotations": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      }
    }
  ]
}

Response

The request has succeeded and a new resource has been created as a result.

OR
OR

Example response

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