Managing Product Entitlements

Product Entitlements are used for mapping a feature and its entitlement levels to various product catalog items. Here, you can add or update a product catalog item (plans, addons, and charges) for a feature. For each product catalog item, you can select your preferred entitlement level.

Example:

John Doe runs a business and offers the plans Basic, Standard, and Advanced. John wants to offer Additional users as a feature, with quantity field values set as 5, 10, and 20 users.

After setting up the feature, John intends to offer this feature on all plans but also has to restrict the entitlement level (in this case number of users) on each plan. This can be set up on the Add Entitlements page.

All John needs to do is select the plans Basic, Standard, and Advanced from the list of product catalog items. Select the Entitlement level as 5 users for Basic, 10 users for Standard and 20 users for Advanced plans using the drop-down list. This way each plan is assigned a particular entitlement level of that feature.

Product entitlement values for metered and non-metered features

What the entitlement value on a product catalog item means depends on the kind of feature:

• Non-metered feature: The value is the access the item gives the customer: Available for a switch-type feature, or a limit or level for a quantity, range, or custom-type feature. Your application enforces the value, and it doesn't affect invoices.
• Metered feature: On a plan or a non-metered addon, the value is the included usage: how much the customer can use before usage counts as overage. Charges don't grant included usage for metered features. When the subscription has a metered addon for the feature, the addon charges for the overage, so included usage affects invoices. By default, metered addons have unlimited entitlements, which don't count toward the included usage. You set the included usage when you link pricing for the metered feature.

An entitlement set on an item applies to all prices of that item. For a metered feature, set the included usage on each item price, so that each price, such as a monthly and a yearly price, carries the usage it includes. An entitlement set on an item price takes precedence over the entitlement set on its item. See Managing Item Price Entitlements.

Changing entitlements for one subscription works differently for metered and non-metered features. See Subscription entitlements for metered and non-metered features.

Adding product entitlement for a feature

The steps in this section apply to non-metered features. To set the included usage of a metered feature, see Linking Pricing for Metered Features.

To define a feature's availability and entitlement levels on various plans, addons, and charges, follow these steps:

1. On the features list page, identify the feature for which you want to assign product entitlements, and click the feature name to open its details.

   

2. On the feature details page, click Add Entitlements.

   

3. Click the + icon, add the specific plans, addons, and charges here to unlock this feature for your customers. You can add one or more catalog items using the + icon. Click Add All to include all plans, addons, and charges at once.

   

4. Choose the Entitlement level value you wish to offer on each product catalog item > click Apply.

   

5. A screen appears with information on the features, addons, and charges added to this plan.

   

6. Click Confirm to save your changes.

7. You can view your changes on the feature details page.

   

Modifying product entitlements for a feature

To modify product entitlements and their entitlement level for a feature, follow these steps:

1. On the feature details page, click Edit to modify the product entitlements.

   

2. Here are the types of modifications: a. Add new product catalog items and entitlement levels. Click the + icon and add the specific plans, addons, and charges. Click Add to include all plans, addons, and charges. b. Modify existing entitlement levels for product catalog items. Choose the Entitlement level you wish to offer on various product catalog items. c. Remove existing product catalog items. Click Remove to exclude the specific plans, addons, and charges. Click Remove All to exclude all plans, addons, and charges.

   

3. Click Confirm to save changes.

   

Which subscriptions a change affects depends on the kind of feature:

• Non-metered feature: Changes to the entitlement, whether to the catalog items or to the entitlement level, apply to new and existing subscriptions of those items. If grandfathering is enabled on your site, you can choose to apply a change to new subscriptions only.
• Metered feature: Changes to the included usage apply only to new subscriptions by default, and existing subscriptions keep their current included usage. To apply a change to existing subscriptions too, see Can you edit the entitlements of a plan or addon after linking a metered feature?

Switch-type features

A switch-type feature has only two levels of entitlements, it is either available or not available on your product catalog items. For Switch-type features, follow the steps below to add entitlements:

1. Navigate to the Feature details page.
2. Click Add Entitlements.
3. Select all the items that should have access to the feature.
4. Select Available as the Entitlement level for the items.
5. Click Add to save all the configurations.

Quantity-type features

In quantity-type features, each entitlement level of a quantity-type feature corresponds to a specific number of quantity units of the feature. For Quantity-type features, follow the steps below to add entitlements:

1. Navigate to the Feature details page.
2. Click Add Entitlements.
3. Select all the items that should have access to that feature.
4. Select the applicable Entitlement level for each item.
5. Click Add to save all the configurations.

Range-type features

A range-type feature allows you to choose a feature entitlement level within a range for the product catalog item. You can set maximum and minimum entitlement levels for a range-type feature. For Range-type features, follow the steps below to add entitlements:

1. Navigate to the Feature details page.
2. Click Add Entitlements.
3. Select all the items that should have access to that feature.
4. Select any Entitlement level within the range you had provided. Here since we had provided 100 - 1000 as the range, we are allowed to select any value within it.
5. Click Add to save all the configurations.

Custom-type features

Because of their nature, certain features do not map to the feature categories like switch-type, quantity-type, or range-type. All these features can be grouped under the custom-type features. For custom-type features, follow the steps below to add entitlements:

1. Navigate to the Feature details page.
2. Click Add Entitlements.
3. Select all the items that should have access to that feature.
4. Select the appropriate Entitlement level for each item.
5. Click Add to save all the configurations.

Update Item Entitlements

Items represent the products or services that you offer to your customers. Items often differ due to the product features that are available in them. You can make the following changes at the item (plan, addon, or charge) level.

To update the entitlements of an item (plan, addon, or charge), follow these steps:

1. Click Product Catalog > Plans > Select a Plan.

   

2. Scroll down to the Entitlements section > Click Edit.

   

3. From the Entitlements Detail page > Click + to add new entitlements to the plan. You can also change levels of, or remove an entitlement.

   

4. After making the changes to the Entitlements, click Apply to save your changes.

   

   The new changes are reflected in the Entitlements section of your plan.