> ## Documentation Index
> Fetch the complete documentation index at: https://developers.mageloyalty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reward object

> The reward object represents a redeemable reward in the loyalty program.

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

| Field             | Type            | Description                                                                     |
| ----------------- | --------------- | ------------------------------------------------------------------------------- |
| `name`            | string          | Reward display name                                                             |
| `description`     | string \| null  | Optional description                                                            |
| `discount_type`   | string          | Type of discount: `fixed_amount`, `percentage`, `free_shipping`, `free_product` |
| `reward_type`     | string          | Either `discount` (standard) or `tier` (VIP tier exclusive)                     |
| `points_cost`     | integer         | Points required to redeem this reward                                           |
| `discount_amount` | number          | The discount value (e.g. `5.00` for £5 off)                                     |
| `minimum_spend`   | number \| null  | Minimum order value required to use the discount                                |
| `is_active`       | boolean         | Whether the reward is currently available                                       |
| `max_redemptions` | integer \| null | Maximum total redemptions allowed, or `null` for unlimited                      |
| `expiry_days`     | integer \| null | Number of days the discount code is valid after redemption                      |
| `created_at`      | string          | ISO 8601 timestamp                                                              |
| `updated_at`      | string          | ISO 8601 timestamp                                                              |

## Example

```json theme={null}
{
  "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"
  }
}
```