OBJECT

OfferEligibility

OfferEligibility describes user's eligibility to purchase an Offer.

link GraphQL Schema definition

1type OfferEligibility {
2
3# If the user is eligible for the Offer, then this is set to the
4# time at which the user's benefits would expire if the
5# Offer is purchased. If null, the benefits never expire.
6benefitsEndAt: Time
7
8# If the user is eligible for the Offer, then this is set to the
9# time at which the user's benefits would become available if the
10# Offer is purchased.
11benefitsStartAt: Time
12
13# A boolean that is true when the user is eligible for the Offer.
14isEligible: Boolean!
15
16# Allows tenants to override the maximum purchasable quantity for an offer
17# within a checkout session (used in purchase velocity cases).
18maxQuantityOverride: Int
19
20# Provides extra contextual details for the type of purchase.
21purchaseType: OfferPurchaseType!
22
23# If the user is ineligible for the Offer, then this code is set
24# as the reason why the user is ineligible.
25reasonCode: OfferIneligibilityReasonCode
26
27}