getCustomerVipTier

Retrieve the VIP tier assigned to the currently logged-in customer, along with their progress value toward the next tier.

Usage

MageSDK.getCustomerVipTier().then(function(resp) {
  if (resp.success) {
    console.log(resp.data.tier);
  }
});

Response

success

boolean

Whether the request was successful.

data.tier

object | null

The customer’s current VIP tier, or null if no tier is assigned.

Show Tier properties

string

The tier ID.

name

string

Display name of the tier (e.g. “Gold”).

description

string | null

Description of the tier, or null if not set.

threshold

number

The tier ranking value. Reflects the requirement measured by the shop’s primary entry method (points, spend, or orders).

pointsMultiplier

number

Points earning multiplier for this tier.

badgeImageUrl

string | null

URL of the tier badge image, or null if not set.

badgeColor

string | null

Hex color code for the tier badge, or null if not set.

data.tierProgressValue

number

The customer’s current progress value toward the next tier.

Sample response

{
  "success": true,
  "data": {
    "tier": {
      "id": "tier_abc",
      "name": "Gold",
      "description": "Our most valued customers",
      "threshold": 500,
      "pointsMultiplier": 1.5,
      "badgeImageUrl": null,
      "badgeColor": "#FFD700"
    },
    "tierProgressValue": 1200
  }
}

JavaScript SDK

Methods

Usage

Response

Sample response

​Usage

​Response

​Sample response

Usage

Response

Sample response