RedemptionConfiguration2

Describes point redemption limitations imposed by the shop.

Kind	Type
Used in	CustomerBalance3, LoggedOutBalance1

Properties

• pt_value monetary required

  Baseline monetary value of 1 loyalty point.

  This is the default conversion rate used when no point value buckets apply. When the shop has configured tiered point value buckets, the actual redemption value may be higher at certain point thresholds.

  Use the point_value_buckets array to calculate actual values, or request pre-calculated bucket amounts from the API when available.

• min integer required

  Minimum number of redeemable points (1 ... ∞)

• max integer | null optional

  Maximum number of points redeemable in this store in a single operation (1 ... ∞), null if unlimited

• step integer required

  Points can only be redeemed in multiples of this number (1 ... ∞)

  Valid redeemable amounts are (min + n * step), i.e. min, (min + step), (min + 2*step), etc.

• buckets array of integer optional

  Preset redemption amounts shown in the UI picker.

  Contains the specific point amounts available in the redemption interface. When configured, present these as the available redemption options.

  If buckets is configured, you should ignore min and step for UI purposes.

• point_value_buckets array of PointValueBucket2 optional

  Tiered point value configuration defining redemption rates at different point thresholds.

  When configured, point values vary based on redemption amount. Each bucket defines a threshold and the monetary value received for exactly that many points.

  To calculate the redemption amount for a given number of points, find the bucket with the highest threshold that the points meet or exceed, then apply: amount = points * value / threshold.

  Example: A bucket with threshold: 400 and value: 25000000 (i.e., $25.00) means 400 points = $25.00, giving an effective rate of 6.25 cents per point. For 500 points, the amount would be 500 * $25.00 / 400 = $31.25.

  When no bucket matches (points below all thresholds), the default pt_value rate is used.