Loyalty API

Type

ReferralCoupon1

Customer-safe display data for one referral reward coupon.

Kind Type
Used in CustomerReferrals2, Refer2

Properties

  • text string required

    Text to display to the customer. URL rewards include the destination host in this text.

  • url string optional

    Safe http or https URL for link-style reward coupons.

  • title string optional

    Customer-facing reward title, when configured.

  • source_label string optional

    Customer-facing source label, such as referral reward or referral bonus.

  • used boolean optional

    True when the coupon is already used or unavailable based on tracked coupon status.

Previous
Referral2