Loyalty tiers

Tiers (levels such as Silver, Gold, Platinum) of a loyalty program.

Programs with tiers_enabled place each member in a tier according to the program tier_basis: lifetime points earned (lifetime_points), lifetime spend (lifetime_spend) or number of visits (visits). A member is in the highest tier whose threshold they reached. The tier is recalculated after every balance movement and shown on the member as tier_id / tier.

A tier earn_multiplier multiplies the points or cashback earned per purchase (not stamps). Rewards can require a minimum tier (min_tier_id).

Endpoints

MethodPathDescription
GET/loyalty-tiersList loyalty tiers
GET/loyalty-tiers/:idGet a loyalty tier
POST/loyalty-tiersCreate a loyalty tier
PATCH/loyalty-tiers/:idUpdate a loyalty tier
DELETE/loyalty-tiers/:idDelete a loyalty tier

The API key is scoped to one organization: reads are filtered to it automatically, and organization_id is required in the body on create.

The loyalty tier object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization of the program. Required on create (must be the program's organization); cannot be changed.
program_idintegerLoyalty program of the tier. Required on create; cannot be changed.
namestringTier name (1 to 120 characters). Required on create.
thresholdnumberValue of the program tier_basis needed to reach the tier, 0 or more. Default 0.
earn_multipliernumberMultiplier applied to points and cashback earned, 0 to 100. Default 1.
benefitsstring | nullText describing the tier benefits (up to 2000 characters).
colorstring | nullTier color shown on the card, for example #F59E0B (up to 16 characters).
sort_orderintegerDisplay order. Default 0.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the tier is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.