Loyalty API
TypeReferralCoupon1
Customer-safe display data for one referral reward coupon.
| Kind | Type |
|---|---|
| Used in | CustomerReferrals2, Refer2 |
Properties
-
textstring requiredText to display to the customer. URL rewards include the destination host in this text.
-
urlstring optionalSafe http or https URL for link-style reward coupons.
-
titlestring optionalCustomer-facing reward title, when configured.
-
source_labelstring optionalCustomer-facing source label, such as referral reward or referral bonus.
-
usedboolean optionalTrue when the coupon is already used or unavailable based on tracked coupon status.