Magidoc

EntitlementCheckResult
Input Object

Result object of an entitlement access check.

Fields

#

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.

enumValues

[ String !]

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

hasAccess

Non-null

Indicates whether the customer currently has access to the feature.

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.

monthlyResetPeriodConfiguration

Configuration for monthly usage reset.

nextResetDate

The next date when the entitlement usage resets.

requestedUsage

The amount of usage requested by the customer.

requestedValues

[ String !]

The values requested by the customer, if applicable.

resetPeriod

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

usageLimit

The maximum allowed usage for this entitlement before restrictions apply.

weeklyResetPeriodConfiguration

Configuration for weekly usage reset.

yearlyResetPeriodConfiguration

Configuration for yearly usage reset.