Loyalty API

Type

SpendChunkBalance1

Leftover spend toward the next spend-chunk reward, in shop currency.

Kind Type
Used in CustomerBalance3, ListCustomers3, LoggedOutBalance1

Properties

  • progress monetary required

    Unconverted spend toward the next spend-chunk reward, in shop currency.

    Leftover spend that has not yet completed a chunk, not lifetime spend. Zero when the customer has no leftover.

  • threshold monetary required

    Spend required to complete the next chunk, in shop currency.

    The current chunk size.

  • remaining monetary required

    Spend still needed to complete the next chunk, in shop currency.

    Equal to threshold minus progress, not below zero.

  • next_reward integer required

    Points the customer will receive when the next spend chunk completes.

    The conversion rate in effect now (current tier and Adjust Spend Chunk rewards), not rates stored on leftover spend.

Previous
SpecialDate1