Loyalty Tier Downgraded

The EVENTS.CUSTOMER.LOYALTY.TIER.DOWNGRADED event indicates that a customer has moved to a lower tier or a specific tier in a loyalty campaign. This event is used in a webhook configured in Distributions in Voucherify dashboard.

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Introduction to webhooks page.

Body

application/json

Event data object schema for customer.loyalty.tier.downgraded.

customer

Simple Customer · object

required

Simplified customer data.

Show child attributes

customer.id

string

Unique identifier of an existing customer. It is assigned by Voucherify.

customer.name

string

Customer's first and last name.

customer.email

string

Customer's email address.

customer.source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

customer.metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

customer.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

campaign

Simple Campaign · object

required

Simplified campaign data.

Show child attributes

campaign.id

string

Campaign ID.

campaign.name

string

Campaign name.

campaign.campaign_type

string

Type of campaign.

campaign.type

enum<string>

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.

AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
STATIC: vouchers need to be manually published
STANDALONE: campaign for single vouchers

Available options:

AUTO_UPDATE,

STATIC,

STANDALONE

campaign.is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

campaign.voucher

Simple Campaign Voucher · object

Simplified campaign voucher data.

Show child attributes

campaign.voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.voucher.redemption

object

required

Defines the redemption limits on vouchers.

Show child attributes

campaign.voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

campaign.voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

campaign.voucher.code_config

Code Config Settings · object

required

Schema containing information about config used for voucher. Defines the code pattern (prefix, suffix, length, charset, etc).

Show child attributes

campaign.voucher.code_config.length

number

required

Number of characters in a generated code (excluding prefix and postfix).

campaign.voucher.code_config.charset

string

required

Characters that can appear in the code.

campaign.voucher.code_config.prefix

string

required

A text appended before the code.

campaign.voucher.code_config.postfix

string

required

A text appended after the code.

campaign.voucher.code_config.pattern

string

required

A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.

campaign.voucher.code_config.initial_count

integer

The initial count.

campaign.voucher.discount

Discount · object

Defines the voucher discount type and details. It will not be returned at all or it will return a null for LOYALTY_CARD.

Discount
Discount
Discount
Discount
Discount

Show child attributes

campaign.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

campaign.voucher.discount.amount_off

number

required

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

campaign.voucher.discount.amount_off_formula

string

campaign.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

campaign.voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

campaign.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

campaign.voucher.gift

Gift · object

Defines the voucher gift details. It will not be returned at all or it will return a null for LOYALTY_CARD.

Show child attributes

campaign.voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

campaign.voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

campaign.voucher.gift.effect

enum<string>

Defines how the credits are applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

campaign.voucher.loyalty_card

Campaign Loyalty Card · object

Defines the voucher loyalty card details. It will not be returned at all or it will return a null for DISCOUNT_VOUCHER or GIFT_CARD.

Show child attributes

campaign.voucher.loyalty_card.points

integer

required

The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card.

campaign.voucher.loyalty_card.expiration_rules

object

Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.

Show child attributes

campaign.voucher.loyalty_card.expiration_rules.period_type

enum<string>

required

Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields.

Available options:

FIXED_DAY_OF_YEAR,

MONTH

campaign.voucher.loyalty_card.expiration_rules.period_value

integer

Value of the period. Required for the period_type: MONTH.

campaign.voucher.loyalty_card.expiration_rules.rounding_type

enum<string>

Type of rounding of the expiration period. Optional for the period_type: MONTH.

Available options:

END_OF_MONTH,

END_OF_QUARTER,

END_OF_HALF_YEAR,

END_OF_YEAR,

PARTICULAR_MONTH

campaign.voucher.loyalty_card.expiration_rules.rounding_value

integer

Value of rounding of the expiration period. Required for the rounding_type.

campaign.voucher.loyalty_card.expiration_rules.fixed_month

integer

Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR.

Required range: 1 <= x <= 12

campaign.voucher.loyalty_card.expiration_rules.fixed_day

integer

Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

Required range: 1 <= x <= 31

campaign.referral_program

Referral Program · object

Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.

Show child attributes

campaign.referral_program.conversion_event_type

enum<string>

Defines how a referral is triggered.

Available options:

redemption,

custom_event

campaign.referral_program.custom_event

object

Contains details about the custom event.

Show child attributes

campaign.referral_program.custom_event.id

string

Unique custom event ID.

Example:

"ms_Ll9enAm2BCN0M1s4VxWobLFM"

campaign.referral_program.custom_event.name

string

Custom event name.

campaign.referral_program.referee_reward

object

Defines the referee reward.

Show child attributes

Details of the resource from which the reward originates.

Show child attributes

Unique identifier of the reward source.

Example:

"camp_kdxp3vf1clQ9CFs1jpqv3tZe"

Name of the reward source.

Type of resource represented by the source of the reward.

Available options:

CAMPAIGN

campaign.referral_program.referee_reward.type

enum<string>

Type of reward.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.referral_program.referee_reward.amount

string

Define the number of points to add to a loyalty card or credits to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

campaign.auto_join

boolean

Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.

campaign.join_once

boolean

If this value is set to true, customers will be able to join the campaign only once. It is always false for standalone voucher campaigns and it cannot be changed in them. It is always true for loyalty campaigns.

campaign.active

boolean

Indicates whether the campaign is active.

campaign.category_id

string | null

The unique category ID that this campaign belongs to.

campaign.category

string

Unique category name.

campaign.categories

Category · object[]

Contains details about the category.

Show child attributes

campaign.categories.id

string

required

Unique category ID assigned by Voucherify.

campaign.categories.name

string

required

Category name.

campaign.categories.hierarchy

integer

required

Category hierarchy.

campaign.categories.created_at

string<date-time>

required

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

Example:

"2024-01-01T11:11:11.111Z"

campaign.categories.object

enum<string>

default:category

required

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

Available options:

category

campaign.categories.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

campaign.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

campaign.metadata

object

A set of custom key/value pairs that you can attach to a campaign. The metadata object stores all custom attributes assigned to the campaign.

campaign.start_date

string<date-time>

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

Example:

"2022-09-20T00:00:00.000Z"

campaign.expiration_date

string<date-time>

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

Example:

"2022-09-30T00:00:00.000Z"

campaign.description

string

An optional field to keep extra textual information about the campaign such as a campaign description and details.

campaign.created_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

campaign.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

campaign.object

enum<string>

default:campaign

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

Available options:

campaign

loyalty_tier_from

Loyalty Tier · object

required

Loyalty tier data.

Show child attributes

loyalty_tier_from.name

string

required

Loyalty Tier name.

loyalty_tier_from.earning_rules

object

required

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

Show child attributes

loyalty_tier_from.earning_rules.{key}

MappingPoints · object

MappingPoints
MappingPoints

Show child attributes

loyalty_tier_from.earning_rules.{key}.type

enum<string>

default:MULTIPLY

Type of calculation.

Available options:

MULTIPLY

loyalty_tier_from.earning_rules.{key}.multiplier

number

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

loyalty_tier_from.rewards

object

required

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

Show child attributes

loyalty_tier_from.rewards.{key}

MappingPoints · object

MappingPoints
MappingPoints

Show child attributes

loyalty_tier_from.rewards.{key}.type

enum<string>

default:MULTIPLY

Type of calculation.

Available options:

MULTIPLY

loyalty_tier_from.rewards.{key}.multiplier

number

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

loyalty_tier_from.points

object

required

Defines range of loyalty tier in points.

Show child attributes

loyalty_tier_from.points.from

integer

Bottom points threshold value.

loyalty_tier_from.points.to

integer

Top points threshold value.

loyalty_tier_from.id

string

required

Unique loyalty tier ID.

loyalty_tier_from.campaign_id

string

required

Unique parent campaign ID.

loyalty_tier_from.metadata

object

required

The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that can be attached to a loyalty tier object.

loyalty_tier_from.created_at

string<date-time>

required

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

loyalty_tier_from.config

object

required

Defines loyalty tier range in points.

Show child attributes

loyalty_tier_from.config.points

object

required

Defines range of loyalty tier in points.

Show child attributes

loyalty_tier_from.config.points.from

integer

Bottom points threshold value.

loyalty_tier_from.config.points.to

integer

Top points threshold value.

loyalty_tier_from.object

enum<string>

default:loyalty_tier

required

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

Available options:

loyalty_tier

loyalty_tier_from.updated_at

string<date-time> | null

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

loyalty_tier_from.expiration

Loyalty Tier Expiration · object

Defines loyalty tier expiration date.

Show child attributes

loyalty_tier_from.expiration.customer_id

string

required

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

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

loyalty_tier_from.expiration.campaign_id

string

required

Unique identifier of the campaign.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

loyalty_tier_from.expiration.tier_id

string

required

Unique identifier of the tier.

loyalty_tier_from.expiration.created_at

string<date-time>

required

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

Example:

"2024-01-01T11:11:11.111Z"

loyalty_tier_from.expiration.start_date

string

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

loyalty_tier_from.expiration.expiration_date

string

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

loyalty_tier_from.expiration.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

loyalty_tier_to

Loyalty Tier · object

required

Loyalty tier data.

Show child attributes

loyalty_tier_to.name

string

required

Loyalty Tier name.

loyalty_tier_to.earning_rules

object

required

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

Show child attributes

loyalty_tier_to.earning_rules.{key}

MappingPoints · object

MappingPoints
MappingPoints

Show child attributes

loyalty_tier_to.earning_rules.{key}.type

enum<string>

default:MULTIPLY

Type of calculation.

Available options:

MULTIPLY

loyalty_tier_to.earning_rules.{key}.multiplier

number

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

loyalty_tier_to.rewards

object

required

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

Show child attributes

loyalty_tier_to.rewards.{key}

MappingPoints · object

MappingPoints
MappingPoints

Show child attributes

loyalty_tier_to.rewards.{key}.type

enum<string>

default:MULTIPLY

Type of calculation.

Available options:

MULTIPLY

loyalty_tier_to.rewards.{key}.multiplier

number

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

loyalty_tier_to.points

object

required

Defines range of loyalty tier in points.

Show child attributes

loyalty_tier_to.points.from

integer

Bottom points threshold value.

loyalty_tier_to.points.to

integer

Top points threshold value.

loyalty_tier_to.id

string

required

Unique loyalty tier ID.

loyalty_tier_to.campaign_id

string

required

Unique parent campaign ID.

loyalty_tier_to.metadata

object

required

The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that can be attached to a loyalty tier object.

loyalty_tier_to.created_at

string<date-time>

required

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

loyalty_tier_to.config

object

required

Defines loyalty tier range in points.

Show child attributes

loyalty_tier_to.config.points

object

required

Defines range of loyalty tier in points.

Show child attributes

loyalty_tier_to.config.points.from

integer

Bottom points threshold value.

loyalty_tier_to.config.points.to

integer

Top points threshold value.

loyalty_tier_to.object

enum<string>

default:loyalty_tier

required

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

Available options:

loyalty_tier

loyalty_tier_to.updated_at

string<date-time> | null

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

loyalty_tier_to.expiration

Loyalty Tier Expiration · object

Defines loyalty tier expiration date.

Show child attributes

loyalty_tier_to.expiration.customer_id

string

required

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

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

loyalty_tier_to.expiration.campaign_id

string

required

Unique identifier of the campaign.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

loyalty_tier_to.expiration.tier_id

string

required

Unique identifier of the tier.

loyalty_tier_to.expiration.created_at

string<date-time>

required

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

Example:

"2024-01-01T11:11:11.111Z"

loyalty_tier_to.expiration.start_date

string

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

loyalty_tier_to.expiration.expiration_date

string

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

loyalty_tier_to.expiration.updated_at

string<date-time>

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

Example:

"2024-01-01T11:11:11.111Z"

created_at

string<date-time>

required

Timestamp representing the date and time when the customer entered a lower loyalty tier.

Example:

"2022-02-25T13:32:08.734Z"

Response

Webhook accepted

Introduction

Endpoints

Events

Loyalty Tier Downgraded

Body

Response