1. Product Catalog
  2. Item entitlements

Item entitlements

item_entitlements
copy
Click to Copy
Item Entitlements refer to all the features that a particular item is entitled to.

Columns

No match found
id string, not null
Primary Key
A unique identifier for the item_entitlement. This is auto-generated.
item_id string, null
Foreign Key items.id
The id of the item to which this entitlement belongs.
feature_id string, null
The id of the feature towards which this entitlement has been granted.
feature_name string, null
The name of the feature towards which this entitlement has been granted.
item_type string, null
The type of the item to which this entitlement belongs.
name string, null
The display name for the entitlement level. The default values are auto-generated based on feature.type as follows:
  • When feature.type is quantity or range, then name is the space-separated concatenation of value and the pluralized version of feature.unit. For example, if value is 20 and feature.unit is user, then name becomes 20 users.
  • When feature.type is custom, then name is the same as value.a
value string, null
The level of entitlement that the item has towards the feature. The possible values depend on the value of feature.type:
  • When feature.type is quantity and:
    • If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any one of feature.levels[value][].
    • If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can also be:
      • any one of feature.levels[value][]
      • or it can be unlimited (case-insensitive), indicating unlimited entitlement.
  • When type is range and:
    • If feature.levels[is_unlimited] is not true for any one of feature.levels[], then the value can be any whole number between levels[value][0] and levels[value][1] (inclusive).
    • If feature.levels[is_unlimited] is true for one of the feature.levels[], then the value can be:
      • any whole number equal to or greater than levels[value][0]
      • or it can be unlimited (case-insensitive), indicating unlimited entitlement.
  • When type is custom, then the value can be any one of feature.levels[value][].
  • When type is switch, then the value is set as available or true.