Skip to main content

Loyalty Tier

All of:
  1. Loyalty Tier Base
  2. AttributesDescription
    idstringUnique loyalty tier ID.
    campaign_idstringUnique parent campaign ID.
    metadataobject, nullThe metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.
    created_atstringTimestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.
    updated_atstring, nullTimestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.
    configobjectDefines loyalty tier range in points.Attributes Descriptionpointsobject Defines range of loyalty tier in points. Attributes Descriptionfrominteger Bottom points threshold value. tointeger Top points threshold value.
    expirationSee: Loyalty Tier Expiration
    objectstringThe type of the object represented by JSON. This object stores information about the loyalty.Available values: loyalty_tier

Loyalty Tier Base

AttributesDescription
namestringLoyalty Tier name.
earning_rulesobjectContains a list of earning rule IDs and their points mapping for the given earning rule.Attributes Description[propertyName] See: MappingPoints
rewardsobjectContains a list of reward IDs and their points mapping for the given reward.Attributes Description[propertyName] See: MappingPoints
pointsobjectDefines range of loyalty tier in points.Attributes Descriptionfrominteger Bottom points threshold value. tointeger Top points threshold value.

Loyalty Tier Expiration

AttributesDescription
customer_idstringUnique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.Example:cust_7iUa6ICKyU6gH40dBU25kQU1
campaign_idstringUnique campaign ID, assigned by Voucherify.Example:camp_rRsfatlwN7unSeUIJDCYedal
tier_idstringUnique tier ID, assigned by Voucherify.
start_datestringActivation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date.
expiration_datestringExpiration timestamp defines when the loyalty tier expires in ISO 8601 format. Loyalty tier is inactive after this date.
created_atstringTimestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
updated_atstringTimestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z

MappingPoints

One of: MappingMultiply, MappingFixed

MappingMultiply

AttributesDescription
typestringType of calculation.Available values: MULTIPLY
multipliernumberMultiplication factor used to multiply the points to obtain the mapped points.

MappingFixed

AttributesDescription
typestringType of calculation.Available values: CUSTOM
pointsintegerFixed number of points to be applied.
I