Loyalty API
TypeRedemptionLimitInfo1
Describes redemption limit amounts in points and remaining allowance for point redemptions.
| Kind | Type |
|---|---|
| Used in | CustomerBalance3, LoggedOutBalance1 |
Properties
-
totalinteger requiredTotal points limit for redemptions within the specified period.
This is the maximum number of points that can be redeemed within the time period. The limit is enforced based on the number of points being redeemed, not their monetary value.
-
remaininginteger requiredRemaining points allowance for the current period.
Calculated as the total points limit minus points already redeemed in the current period. When this reaches zero, no further point redemptions are allowed until the period resets.
-
The time period for which this limit applies.
An enum value that determines when the customer's points redemption allowance resets. See
LimitPeriod1for possible values.The period determines the frequency at which the customer's used points are reset, allowing them to redeem up to the total limit again.