Magidoc

PromotionalEntitlement
Object

Promotional entitlement

Fields

#

createdAt

DateTime

Timestamp of when the record was created

customer

Customer !
Non-null

description

String

The description of the entitlement

endDate

DateTime

The end date of the promotional entitlement

environmentId

String !
Non-null

The unique identifier for the environment

feature

Feature !
Non-null

featureId

String !
Non-null

The unique identifier of the entitlement feature

hasSoftLimit

Boolean

Whether the entitlement has a soft limit

hasUnlimitedUsage

Boolean

Whether the entitlement has an unlimited usage

id

String !
Non-null

isVisible

Boolean !
Non-null

Whether the entitlement is visible

meter

Meter

period

PromotionalEntitlementPeriod !
Non-null

The grant period of the promotional entitlement

resetPeriod

EntitlementResetPeriod

The reset period of the entitlement

resetPeriodConfiguration

ResetPeriodConfiguration

The reset period configuration of the entitlement

startDate

DateTime !
Non-null

The start date of the entitlement

status

PromotionalEntitlementStatus !
Non-null

The status of the entitlement

unlimited

Boolean

Whether the entitlement has an unlimited usage

updatedAt

DateTime

Timestamp of when the record was last updated

usageLimit

Float

The usage limit of the entitlement

Usages

#

References

#

  • Field promotionalEntitlements from Customer
  • Field createManyPromotionalEntitlements from Mutation