Introducing the Chargebee CLI

Entitlement Versions

Currently, this feature is in EAP. Please write to Chargebee Support at eap@chargebee.com to get this enabled.

Entitlement versions track changes to entitlements applied to features of items or item prices. A new version of the entitlement is created whenever it's added or updated with grandfathering enabled. In other words, this applies when the change is intended only for new subscriptions. This versioning system ensures accurate entitlement calculations for subscriptions based on when they were created.

How Versions Work

  • Version Creation: A new version is created each time an entitlement is added or updated for an item or item price and applied to all new subscriptions.

  • Subscription Applicability: The latest version is applied only to subscriptions created after the version's effective date.

  • Entitlement Calculation: The total entitlement value for a subscription is calculated using the version of each entitlement applicable at the time of subscription creation.

Entitlement versions for metered features

For a metered feature, the entitlement is the included usage on a plan price or a non-metered addon price. Changes to included usage follow the grandfathering model by default, so a change applies only to new subscriptions, and subscriptions created before the change 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?

Viewing Entitlement Versions

You can view entitlement versions from the Features page:

  1. Navigate to Entitlements, and click Features.
  1. Select a feature for which you want to view the entitlement versions.
  1. Under Entitlement Version, click View. The version details will be displayed, including:
    • Feature name
    • Item and Item Price
    • Creation and modification timestamps
    • Entitlement values
    • Reason for change
    • Current and applicable package version