Member balances

A loyalty member may have access to one or more balance types, depending on the configuration of the member's assigned club. Each member balance has a separate available balance, indicating how many balance units the member can redeem.

Balance types

A balance type describes the configuration of a balance that a member has access to. Each balance type has an earning rate and redemption rate, which determines how members earn and redeem balance units.

Balance units

Each balance type has an assigned "unit", commonly referred to as "points". The unit is the 'currency' for the balance type and should be used whenever displaying a member's available balance, e.g., "200 ABC Dollars".

Available balance

Use the GetCurrentMember endpoint to get this list of available balances for the authenticated member.

{
  "member": {
    "id": "string",
    "hash": "string",
    "balances": [
      {
        "balanceTypeId": 0,
        "availableUnits": 0.1,
        "expiries": [
          {
            "units": 0.1,
            "expiresAt": "2019-08-24T14:15:22Z"
          }
        ]
      }
    ]
  },
  "relatedData": {
    "balanceTypes": [
      {
        "id": 0,
        "name": {
          "text": "string",
          "translations": [
            {
              "languageTag": "string",
              "text": "string"
            }
          ]
        },
        "isPrimary": true,
        "unitName": "string",
        "paymentConversionRate": 0.1
      }
    ]
  }
}

Each balance type the member is assigned will have an availableUnits, which indicates the maximum units the member can redeem during their next order.

Expiring balance units

Earned balance units may automatically expire. Use the GetCurrentMember endpoint to get the current available balance, including the details of any upcoming expiries.

Earning balance units

Balance types with a configured earning rate will automatically add balance units to a member's available balance upon completion of an order during an authenticated loyalty session.

Earning rate

The earning rate of a balance type determines how many balance units a member receives when completing an order during an authenticated loyalty session.

An earning rate of 1.0 means that the member receives one balance unit for every dollar spent, whereas an earning rate of 0.5 means that the member would receive half a balance unit for every dollar spent.

Redeeming balance units

Members may choose to redeem their earned balance units in exchange for member-only benefits.

Redemption rate

The redemption rate of a balance type determines how many balance units need to be redeemed to make a member balance payment.

A redemption rate of 1.0 means that each balance unit can be redeemed for one dollar during a member balance payment, whereas a redemption rate of 0.5 means that each balance unit can be redeemed for a member balance payment of 50 cents.

Use the GetMaximumMemberBalancePayment endpoint to get the maximum possible member balance payments for an in-progress order based on the configured redemption rate.

Redemption exclusions

A balance type with a configured redemption rate may also have redemption exclusions. These exclusions are typically used to prevent the payment of certain items with member balance units, such as alcoholic drinks.

Redemption exclusions are automatically considered by the GetMaximumMemberBalancePayment endpoint. See the member balance payments page for more info.

Member rewards

Certain member rewards have an associated balance cost. These rewards require the member to have sufficient available balance to redeem the reward.

Member balance payments

Earned balance units belonging to a balance type with a configured redemption rate can be redeemed for member balance payments.