Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.mageloyalty.com/llms.txt

Use this file to discover all available pages before exploring further.

VIP tiers define the levels of your loyalty program. Customers are automatically assigned to tiers based on their lifetime points.

​
Attributes

FieldTypeDescription
namestringTier display name
descriptionstring | nullOptional description
points_requiredintegerLifetime points required to reach this tier
points_multipliernumberPoints earning multiplier for members of this tier
badge_image_urlstring | nullURL to the tier badge image
badge_colorstring | nullHex color code for the tier badge
rewardsarrayTier-exclusive rewards automatically granted to members
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

​
Embedded rewards

Each item in the rewards array contains:
FieldTypeDescription
idstringReward ID
namestringReward name
descriptionstring | nullOptional description
discount_typestringDiscount type
reward_typestringAlways tier for tier-exclusive rewards
points_costintegerPoints cost
discount_amountnumberDiscount value
minimum_spendnumber | nullMinimum order value
is_activebooleanWhether the reward is active
max_redemptionsinteger | nullMaximum redemptions
expiry_daysinteger | nullDays until discount code expires
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

​
Example

{
  "type": "vip_tier",
  "id": "tier_gold",
  "attributes": {
    "name": "Gold",
    "description": "Premium tier",
    "points_required": 500,
    "points_multiplier": 1.5,
    "badge_image_url": null,
    "badge_color": "#FFD700",
    "rewards": [
      {
        "id": "reward_abc",
        "name": "£5 off your next order",
        "description": null,
        "discount_type": "fixed",
        "reward_type": "tier",
        "points_cost": 500,
        "discount_amount": 5.00,
        "minimum_spend": 20.00,
        "is_active": true,
        "max_redemptions": null,
        "expiry_days": 30,
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z"
      }
    ],
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}