Ad Reward

Important

The max amount is per offer.

Property	Type	Description
purchaseRequirement	PurchaseRequirement	Purchase requirement information associated with a redemption
rewardAmount	float	Either a fixed amount or a percentage, depending on `rewardType`
maxRewardAmount	float	Maximum allowable redemption amount
rewardType	RewardType	The type of reward yielded by a redemption
isMultiRedemption	boolean	Indicates whether a multiple number of redemptions is allowed for this offer
maxNumRedemptions	int	1 when isMultiRedemption=false, null or omitted when isMultiRedemption=true
isMultiTier	boolean	Indicates whether the reward is tiered
activationModel	ActivationModel	Activation requirements for the CLO offer. Default value is "ACTIVATABLE". For auto-activated, the value is "AUTO_ACTIVATED".
publisherAnnotations	PublisherAnnotations	A set of indicators that shows different types of offers based on billing and user segments.
cumulative	boolean	New. Indicates the offer is a cumulative (progress-based) offer. Omitted or `false` for standard one-time offers.
cumulativeType	string	New. The type of accumulation required to earn the reward. Values: `SPEND`, `TRIPS`, `REDEMPTIONS`. Only present when `cumulative` is `true`.
requiredCumulativeThreshold	float	New. The goal the customer must reach: minimum spend amount ($) for `SPEND`, trip count for `TRIPS`, or redemption count for `REDEMPTIONS`. Only present when `cumulative` is `true`.
currentCumulativeValue	float	New. The customer's current accumulated value: accumulated spend ($), trip count, or redemption count. Only present when `cumulative` is `true`.

Important

The four cumulative progress fields (cumulative, cumulativeType, requiredCumulativeThreshold, currentCumulativeValue) are optional and additive. They are omitted for standard one-time offers, and also omitted when progress data is unavailable for a cumulative offer. Existing consumers see no breaking change, but must handle the absence of these fields gracefully.

`PERCENT_AMOUNT_PURCHASE` Ad Reward example

The following example depicts a 2% cash back online offer, with a $10 maximum reward.

        "rewardType": "PERCENT_AMOUNT_PURCHASE",
        "rewardAmount": 2.0,
        "maxRewardAmount": 10.0,
        "isMultiRedemption": false,
        "maxNumRedemptions": 1,
        "isMultiTier": false,
        "purchaseRequirement": {
          "minSpendAmount": 0.2,
          "purchaseChannels": [
            "Online"
          ],
          "merchantUrlLinkClickRequired": false
        },
        "activationModel": "ACTIVATABLE",
        "publisherAnnotations": []

`FIXED_AMOUNT_PURCHASE` Ad Reward example

The following example depicts a fixed $50 cash back offer, valid online and in-store, with a $75 minimum spend.

        "rewardType": "FIXED_AMOUNT_PURCHASE",
        "rewardAmount": 50.0,
        "maxRewardAmount": 50.0,
        "isMultiRedemption": false,
        "maxNumRedemptions": 1,
        "isMultiTier": false,
        "purchaseRequirement": {
          "minSpendAmount": 75.0,
          "purchaseChannels": [
            "Online",
            "InStore"
          ],
          "purchaseTypes": [
            "Subscription"
          ],
          "merchantUrlLinkClickRequired": false
        },
        "activationModel": "ACTIVATABLE",
        "publisherAnnotations": ["PUBLISHER_FUNDED"]

Cumulative Ad Reward examples (New)

Spend accumulation, in progress. The customer must spend a cumulative $200 to earn $20 and has spent $140 so far.

        "rewardType": "FIXED_AMOUNT_PURCHASE",
        "rewardAmount": 20.00,
        "maxRewardAmount": 20.00,
        "isMultiRedemption": false,
        "purchaseRequirement": {
          "minSpendAmount": 1.00
        },
        "cumulative": true,
        "cumulativeType": "SPEND",
        "requiredCumulativeThreshold": 200.00,
        "currentCumulativeValue": 140.00

Trips accumulation, no progress yet. The customer must complete 5 qualifying transactions and has completed none.

        "cumulative": true,
        "cumulativeType": "TRIPS",
        "requiredCumulativeThreshold": 5,
        "currentCumulativeValue": 0

Cumulative bonus redemption, goal met. The customer must complete 3 redemptions and has completed all 3.

        "cumulative": true,
        "cumulativeType": "REDEMPTIONS",
        "requiredCumulativeThreshold": 3,
        "currentCumulativeValue": 3

Ad Reward

PERCENT_AMOUNT_PURCHASE Ad Reward example

FIXED_AMOUNT_PURCHASE Ad Reward example

Cumulative Ad Reward examples (New)

`PERCENT_AMOUNT_PURCHASE` Ad Reward example

`FIXED_AMOUNT_PURCHASE` Ad Reward example