Loyalty API

Type

PointValueBucket2

Defines a tiered point-to-amount conversion bucket.

Kind Type
Used in CustomerBalance3, LoggedOutBalance1

Point value buckets enable shops to offer better redemption rates at higher point thresholds, incentivizing larger redemptions. When a customer redeems points at or above a bucket's threshold, the redemption uses that bucket's value-per-threshold ratio instead of the default rate.

The calculation formula is: amount = points * value / threshold. For example, a bucket with threshold 400 and value $25.00 gives an effective rate of 6.25 cents per point (compared to a default rate of 5 cents per point).

Properties

  • threshold integer required

    Minimum points for this bucket to apply.

    When a customer redeems at least this many points, this bucket's conversion rate applies.

    Buckets are matched from highest to lowest threshold. The bucket with the highest threshold that the customer's points meet or exceed is used.

  • value monetary required

    Monetary amount received when redeeming exactly threshold points.

    The effective per-point rate is value / threshold.

    For redemptions above threshold, the amount scales proportionally: amount = points * value / threshold.

Previous
OrderLineDetails1