GuidesHelp CenterRelease notesSign up
API Reference

Loyalty Tier Object

Loyalty Tier

All of:

  1. Loyalty Tier Base
  2. AttributesDescription
    id
    string

    Unique loyalty tier ID.

    campaign_id
    string

    Unique parent campaign ID.

    metadata
    object, null

    The 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_at
    string

    Timestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.

    updated_at
    string, null

    Timestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.

    config
    object

    Defines loyalty tier range in points.

    AttributesDescription
    points
    object

    Defines range of loyalty tier in points.

    AttributesDescription
    from
    integer

    Bottom points threshold value.

    to
    integer

    Top points threshold value.

    expirationSee: Loyalty Tier Expiration
    object
    string

    The type of the object represented by JSON. This object stores information about the loyalty.

    Available values: loyalty_tier

Loyalty Tier Base

AttributesDescription
name
string

Loyalty Tier name.

earning_rules
object

Contains a list of earning rule IDs and their points mapping for the given earning rule.

AttributesDescription
[propertyName]See: MappingPoints
rewards
object

Contains a list of reward IDs and their points mapping for the given reward.

AttributesDescription
[propertyName]See: MappingPoints
points
object

Defines range of loyalty tier in points.

AttributesDescription
from
integer

Bottom points threshold value.

to
integer

Top points threshold value.

Loyalty Tier Expiration

AttributesDescription
customer_id
string

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example:

cust_7iUa6ICKyU6gH40dBU25kQU1

campaign_id
string

Unique campaign ID, assigned by Voucherify.

Example:

camp_rRsfatlwN7unSeUIJDCYedal

tier_id
string

Unique tier ID, assigned by Voucherify.

start_date
string

Activation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date.

expiration_date
string

Expiration timestamp defines when the loyalty tier expires in ISO 8601 format. Loyalty tier is inactive after this date.

created_at
string

Timestamp 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_at
string

Timestamp 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
type
string

Type of calculation.

Available values: MULTIPLY
multiplier
number

Multiplication factor used to multiply the points to obtain the mapped points.

MappingFixed

AttributesDescription
type
string

Type of calculation.

Available values: CUSTOM
points
integer

Fixed number of points to be applied.