Magidoc

PriceEntitlement
Object

Entitlement that is granted as part of a price component.

Fields

#

description

String

Detailed description of the entitlement associated with the pricing component.

feature

Feature !
Non-null

The feature this entitlement corresponds to.

featureId

String !
Non-null

The internal ID of the feature linked to this entitlement.

hasSoftLimit

Boolean

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

hasUnlimitedUsage

Boolean

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

package

PackageDTO !
Non-null

The package that this entitlement is associated with.

packageId

String !
Non-null

The internal ID of the package or plan that granted this entitlement.

resetPeriod

EntitlementResetPeriod

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

resetPeriodConfiguration

ResetPeriodConfiguration

Detailed configuration object specifying the usage reset schedule.

updatedAt

DateTime

Timestamp of when the record was last updated

usageLimit

Float

The maximum allowed usage for this entitlement before restrictions apply.

Usages

#

References

#