Reward Object

Customers can spend their loyalty points to redeem a reward. This object is the representation of that reward.

{
  "type": "rewards",
  "id": 123,
  "attributes": {
    "id": 123,
    "name": "$5 off coupon",
    "enabled": true,
    "points_amount": 500,
    "points_type": "fixed",
    "reward_type": "fixed_amount",
    "source": "points",
    "pretty_display_rewards": "$5 off coupon (500 points required)",
    "min_order_value_in_cents": null,
    "expiry_months": null,
    "reward_value": 5,
    "redeemed_count": 3,
    "created_at": "2022-07-27T03:24:03.343Z",
    "updated_at": "2022-07-27T03:24:03.343Z",
    "terms_of_service": {
      "reward_type": "fixed_amount",
      "applies_to": "entire",
      "show_tos": false
    }
  }
}