Skip to main content
Rewards are configured by the merchant and can be redeemed by customers using their points. Each reward generates a Shopify discount code on redemption.

​
Attributes

FieldTypeDescription
namestringReward display name
descriptionstring | nullOptional description
discount_typestringType of discount: fixed_amount, percentage, free_shipping, free_product
reward_typestringEither discount (standard) or tier (VIP tier exclusive)
points_costintegerPoints required to redeem this reward
discount_amountnumberThe discount value (e.g. 5.00 for £5 off)
minimum_spendnumber | nullMinimum order value required to use the discount
is_activebooleanWhether the reward is currently available
max_redemptionsinteger | nullMaximum total redemptions allowed, or null for unlimited
expiry_daysinteger | nullNumber of days the discount code is valid after redemption
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

​
Example

{
  "type": "reward",
  "id": "reward_abc",
  "attributes": {
    "name": "£5 off your next order",
    "description": null,
    "discount_type": "fixed_amount",
    "reward_type": "discount",
    "points_cost": 500,
    "discount_amount": 5.00,
    "minimum_spend": 20.00,
    "is_active": true,
    "max_redemptions": null,
    "expiry_days": 30,
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}