RedemptionLimit

Controls the maximum number of rewards a guest can redeem for this check.

When this object is present (non-null), the Toast POS enforces the limit you specify by disabling the ability to select additional rewards once the limit is reached. Guests can always deselect rewards to choose different ones.

The effective limit accounts for rewards that are already applied. If you return maxRedemptions = 3 and the guest has 1 reward already applied, the guest can select 2 more rewards.

When this object is absent or null, the Toast POS applies no redemption restrictions.

The Toast POS does NOT validate that the appliedRedemptions array length matches the maxRedemptions value. You are responsible for ensuring consistency in your responses. If you send maxRedemptions = 2 but include 5 items in appliedRedemptions, the Toast POS may behave unexpectedly.

This object applies to LOYALTY_INQUIRE responses. For other transaction types, this object should be absent or null.

• maxRedemptions required:
  integer or null >= 0

  The maximum number of rewards the guest may redeem for this check.

  Required field, but the value may be null. The meaning of each value:

  • null: Explicitly allow unlimited redemptions
  • 0: No rewards can be redeemed
  • N (N > 0): Guest can redeem up to N rewards

  You must include this field when providing a RedemptionLimit object. You can adjust this value on each LOYALTY_INQUIRE response based on business rules specific to your loyalty program.

{
  "maxRedemptions": 0
}