Entitlement

Object

accessDeniedReason

Optional message explaining why access to the feature is denied.

currentUsage

The amount of the feature the customer has used so far in the current period.

customerId

displayNameOverride

A custom name to override the default display name for this entitlement.

entitlementUpdatedAt

Timestamp of the last update to the entitlement grant or configuration.

enumValues

List of enum values applicable to this entitlement, if it is an enum feature.

feature

The feature this entitlement corresponds to.

hasSoftLimit

Indicates whether the usage limit is soft — usage can exceed the limit, but will be tracked.

hasUnlimitedUsage

Indicates whether this entitlement grants unlimited usage with no enforced cap.

hiddenFromWidgets

Indicates whether this entitlement should be hidden in customer-facing widgets.

isGranted

Indicates whether the entitlement is currently granted to the customer.

meterId

The ID of the meter tracking usage for this entitlement.

nextResetDate

requestedUsage

The amount of usage requested by the customer.

requestedValues

The values requested by the customer, if applicable.

resetPeriod

The interval at which usage resets automatically, such as monthly or yearly.

resetPeriodConfiguration

Detailed configuration object specifying the usage reset schedule.

resourceId

usageLimit

The maximum allowed usage for this entitlement before restrictions apply.

usagePeriodAnchor

The anchor for calculating the usage period for metered entitlements with a reset period configured

usagePeriodEnd

The end date of the usage period for metered entitlements with a reset period configured

usagePeriodStart

The start date of the usage period for metered entitlements with a reset period configured

usageUpdatedAt

Timestamp of the last update to the usage value.