Get a specific entitlement

GET

subscriptions

{id}

entitlements

{key}

Get a specific entitlement

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

{
  "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

string

required

Unique identifier for the subscription

key

string

required

Unique identifier for the entitlement

Response

Success

mode

string

required

Entitlement mode

Example:

"static"

type

string

required

Entitlement type

Example:

"boolean"

allocation

object

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

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"

Download a subscription PDFReturns the signed contract PDF for a subscription as a binary `application/pdf` response. The document reflects the contract as it was agreed upon with the customer at the point of signing. Returns `404` if the order form was not signed through Alguna and no PDF exists.

⌘I

Get a specific entitlement

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

{
  "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"
}