Zum Hauptinhalt springen
POST
cURL

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

subscriptionId
string
erforderlich

Entitlement identifier

Body

The new Entitlement resource

feature
string<uuid> | null
erforderlich

The feature which should be assigned. Must be in "active" state.

Beispiel:

"https://example.com/"

value
string | null
erforderlich

The value of the feature

validFrom
string<date-time> | null

The date from which the feature is valid

validUntil
string<date-time> | null

The date until which the feature is valid

Antwort

Entitlement resource created

Get all entitlements of a subscription

id
string
read-only
subscriptionItem
object | null
feature
object | null
value
string

The value of the entitlement. Can be a boolean (switch), a string (custom), a number (quantity) or a custom number (range).

Beispiel:

"true"

validFrom
string<date-time> | null

The date from which the entitlement is valid

validUntil
string<date-time> | null

The date until which the entitlement is valid

active
boolean

Whether the entitlement is currently active (computed based on validity dates and enabled state)

status
enum<string>

The status of the entitlement. Computed based on validity dates and enabled state.

Possible values:

  • active: Entitlement is enabled and currently within its validity period
  • pending: Entitlement is enabled but validFrom is in the future
  • disabled: Entitlement is manually disabled
  • expired: Entitlement validUntil date has passed
Verfügbare Optionen:
active,
pending,
disabled,
expired
Beispiel:

"active"