Loyalty Tier Object

Attributes Description Example

Unique loyalty tier ID.

ltr_30KHciA0UG8B71Fo51GZqwgN

name

Loyalty Tier name.

campaign_id

Unique parent campaign ID.

camp_fkZ28pe7DUAEmmabofkxHI8N

metadata

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

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

2022-11-10T12:20:52.755Z

updated_at

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

2022-11-25T10:59:43.231Z

earning_rules

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

Attributes Description Example

unique_earning_rule_ID

ern_95aq3JaE5A8xzHjoJPYNRqXZ

Any of:

Multiply Points

Attributes	Description	Example
type	Type of calculation. Available values: `MULTIPLY`
multiplier	Multiplication factor used to multiply the points to obtain the mapped points.

Fixed Points

Attributes	Description	Example
type	Type of calculation. Available values: `CUSTOM`
points	Fixed number of points to be applied.

rewards

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

Attributes Description Example

unique_reward_ID

rewa_t88DnSdNnE0IzQX6gqH3jHGQ

Any of:

Multiply Points

Attributes	Description	Example
type	Type of calculation. Available values: `MULTIPLY`
multiplier	Multiplication factor used to multiply the points to obtain the mapped points.

Fixed Points

Attributes	Description	Example
type	Type of calculation. Available values: `CUSTOM`
points	Fixed number of points to be applied.

config

Defines loyalty tier range in points.

Attributes

Description

Example

points

Defines range of loyalty tier in points.

Attributes	Description	Example
from	Bottom points threshold value.
to	Top points threshold value.

points

Defines range of loyalty tier in points.

Attributes	Description	Example
from	Bottom points threshold value.
to	Top points threshold value.

object

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