Introduction

The Loyalty Tiers API allows you to create a levels-based program that assigns loyalty accounts to different tiers based on the amount of points they have earned.

With the Loyalty Tiers API, you can:

• Create and update individual tiers.
• Create and update settings that apply globally to the tiers program.
• Retrieve specific tiers, all tiers, or the tier program settings.

For more information about loyalty tiers, see Adding Tiers to Your Loyalty Program.

Before you begin

It's important to note the following points before starting to code:

• A site must have a Plus plan (Wix Studio) or a Business plan (Wix Editor) to add tiers.
• A site must have at least one of these apps: Wix Bookings, Wix Events, Wix Pricing Plans, or Wix Stores.

  Note: Currently, tiers can't be added to Wix Restaurants loyalty programs.

• The tiers program status must be manually set to ACTIVE. Call Update Tiers Program Settings to update the status or enable tiers from a Wix user's dashboard.

Terminology

• Tiers program settings: Settings that apply globally to the overall tiers program.
• Base tier: A default tier for any loyalty account that's unassigned for not meeting the required points threshold of any other tier. The base tier requires 0 points, has no tierId, and isn't returned as a tier when List Tiers is called. When a tiers program status is PAUSED or DISABLED all of the loyalty accounts are assigned to the base tier.
• Rolling window: Period of time used to calculate loyalty points for tier assignment. The total points earned and adjusted during this period determine if the account meets a tier's required point threshold. The window recalculates every 15 minutes or if a new tier event triggers.
• Points earned and adjusted: Tier assignment is based on the total amount of loyalty points earned and adjusted over the period of time in a rollingWindow. If an account redeems points during that period, the points that were earned still count towards tier assignment even if that leaves the remaining points balance below the tier's required point threshold. Similarly, if the current points balance for a loyalty account is above a tier's required points threshold, but those points were earned in a time period earlier than the rollingWindow then those points aren't considered for tier assignment.