OpenMeter Entitlements

Create customer entitlement

Changed on

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

Create an entitlement for the customer.

A customer can have only one active entitlement per feature. The feature must be compatible with the entitlement type. Entitlements cannot be modified after creation, only deleted.

post/v3/openmeter/customers/{customerId}/entitlements

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/customers/{customerId}/entitlements
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

OR
OR

Example request

{
  "feature": {
    "id": "01G65Z755AFWAKHE12NY0CQ9FH"
  },
  "labels": {
    "env": "test"
  },
  "issue": {
    "amount": "100"
  },
  "issue_after_reset": "100",
  "usage_period": {
    "interval": "P1M",
    "anchor": "2023-01-01T01:01:01.001Z"
  },
  "measure_usage_from": "2023-01-01T01:01:01.001Z",
  "grants": [
    {
      "amount": "100",
      "priority": 1,
      "effective_at": "2023-01-01T01:01:01.001Z",
      "expires_after": "P1M",
      "max_rollover_amount": "100",
      "min_rollover_amount": "0",
      "labels": {
        "env": "test"
      },
      "recurrence": {
        "interval": "P1M",
        "anchor": "2023-01-01T01:01:01.001Z"
      }
    }
  ]
}

Response

Entitlement created response.

OR
OR

Example response

{
  "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": "P1M"
  },
  "current_usage_period": {
    "from": "2023-01-01T01:01:01.001Z",
    "to": "2023-01-01T01:01:01.001Z"
  },
  "issue": {
    "amount": "100"
  },
  "issue_after_reset": "100",
  "measure_usage_from": "2023-01-01T01:01:01.001Z",
  "last_reset": "2023-01-01T01:01:01.001Z"
}

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