Magidoc

CustomerPortalPromotionalEntitlement
Object

General description of the promotional entitlement. Use descriptionField instead to avoid key collisions.

Fields

#

description

String

The main descriptive text for the entitlement, explaining what benefit is granted.

displayName

String !
Non-null

The name of the promotional entitlement as it should appear in the Stigg portal.

endDate

DateTime

The date and time when the promotional entitlement expires and is no longer effective.

hasSoftLimit

Boolean

Indicates that the entitlements usage limit is not strictly enforced — customers can exceed it, but their usage is still tracked.

hasUnlimitedUsage

Boolean

Indicates whether this promotional entitlement grants unlimited usage.

period

PromotionalEntitlementPeriod !
Non-null

The time interval after which usage resets automatically.

startDate

DateTime !
Non-null

The date and time when the promotional entitlement becomes active.

usageLimit

Float

The maximum allowed usage for this promotional entitlement, which only applies to metered features.

Usages

#

References

#