Get a specific entitlement

Fetches a single active entitlement on a subscription by its entitlement key.

GET /subscriptions/{id}/entitlements/{key}

Get a specific entitlement

cURL

curl --request GET \
  --url https://api.alguna.io/subscriptions/{id}/entitlements/{key} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

200

{
  "mode": "static",
  "type": "boolean",
  "allocation": {
    "amount": "100000",
    "credit_type": "monetary",
    "rollover_enabled": true,
    "rollover_max_periods": 3
  },
  "key": "api_access",
  "subscription_id": "sub_abc123",
  "timing": {
    "recurrence": "recurring",
    "interval": "monthly"
  },
  "value": "true",
  "version_id": "subv_abc123"
}

Authorizations

Authorization · string · header · required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version · enum<string> · required

Available options: 2026-04-01

Path Parameters

id · string · required

Unique identifier for the subscription

key · string · required

Unique identifier for the entitlement

Response

200

application/json

Success

mode · enum<string> · required

Entitlement mode

Available options: static, grant_based

Example:

"static"

type · enum<string> · required

Entitlement type

Available options: boolean, number, string, credit_allocation

Example:

"boolean"

allocation · object | null

Credit allocation config

Show child attributes

key · string | null

Entitlement key

Example:

"api_access"

subscription_id · string | null

Owning subscription ID; null for default-profile entitlements

Example:

"sub_abc123"

timing · object | null

Timing config

Show child attributes

value · string

Entitlement value

Example:

"true"

version_id · string | null

Owning subscription version ID; null for default-profile entitlements

Example:

"subv_abc123"