Entitlements

Get entitlement

Changed on

Use when you need to load a single entitlement (e.g. to display or edit a feature limit).

get/entitlements/{id}

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/entitlements/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Entitlement ID

Response

OK

aggregation_mode'additive' | 'parallel'
config_valueobject
created_atstring date-time
created_bystring
display_orderinteger
end_datestring date-time
entity_idstring
entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON'
environment_idstring
feature_idstring
feature_type'metered' | 'boolean' | 'static' | 'config'
grant_allocation_behavior'first_usage' | 'unit_start'
grant_duration_unit'hour' | 'day' | 'week' | 'subscription_period'
grant_duration_valueinteger
grant_measure'quantity' | 'amount'
grant_quotastring
idstring
is_enabledboolean
is_soft_limitboolean
parent_entitlement_idstring
plan_idstring

TODO: Remove this once we have a proper entitlement entity type

start_datestring date-time
static_valuestring
status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring date-time
updated_bystring
usage_limitinteger
usage_reset_period'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'NEVER'

Example response

{
  "addon": {
    "prices": [
      {
        "meter": {
          "created_at": "2024-03-20T15:04:05Z",
          "event_name": "api_request",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "API Usage Meter",
          "status": "published",
          "tenant_id": "tenant123",
          "updated_at": "2024-03-20T15:04:05Z"
        }
      }
    ]
  },
  "feature": {
    "meter": {
      "created_at": "2024-03-20T15:04:05Z",
      "event_name": "api_request",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "API Usage Meter",
      "status": "published",
      "tenant_id": "tenant123",
      "updated_at": "2024-03-20T15:04:05Z"
    }
  },
  "plan": {
    "prices": [
      {
        "meter": {
          "created_at": "2024-03-20T15:04:05Z",
          "event_name": "api_request",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "API Usage Meter",
          "status": "published",
          "tenant_id": "tenant123",
          "updated_at": "2024-03-20T15:04:05Z"
        }
      }
    ]
  }
}

Changes

  • 96879a6887fcRevision changes
    • info

      added the optional property / to the response with the status

  • e36fe54e0efbRevision changes
    • info

      added the optional property // to the response with the status