Skip to content

Purchase Requirements

A purchase requirement object contains information on required or disqualifying purchases for an offer.

Property Type Description
minSpendAmount float Minimum purchase amount required to redeem
purchaseChannels PurchaseChannel[] Any PurchaseChannels associated with a potentially qualifying purchase
purchaseTypes PurchaseType[] The PurchaseType associated with a potentially qualifying purchase
merchantUrlLinkClickRequired boolean If a customer needs to click on the merchant url in order to redeem the offer

PurchaseType

The PurchaseType enumeration defines various product types that an offer may be contingent upon.

The values are represented as string in the API response.

Value Description
Subscription A recurring subscription, such as to an online streaming service or a utility.
Membership A membership to a club, warehouse store, organization, etc.
Fuel Gasoline, diesel, etc. Used for gas station offers to require or exclude the purchase of gas for offers.

Examples

This offer requires a fuel purchase from a gas pump: 

1
2
3
4
5
6
7
8
{
    "minSpendAmount": 5.0,
    "purchaseChannels": ["PayAtPump"],
    "purchaseTypes": [
        "Fuel"
    ],
    "merchantUrlLinkClickRequired": false
}

This offer requires the purchase of a $25 membership. It also requires the customer to click on the merchant url in order to redeem the offer: 

1
2
3
4
5
6
7
8
{
    "minSpendAmount": 25.0,
    "purchaseChannels": ["InStore"],
    "purchaseTypes": [
        "Membership"
    ],
    "merchantUrlLinkClickRequired": true
}