id
string

Unique promotion tier ID.

Example: promo_63fYCt81Aw0h7lzyRkrGZh9p

created_at
string

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

Example: 2021-12-15T11:34:01.333Z

updated_at
string

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

Example: 2022-02-09T09:20:05.603Z

name
string

Name of the promotion tier.

banner
string

Text to be displayed to your customers on your website.

action
object

Contains details about the discount applied by the promotion tier.

metadata
object

The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.

hierarchy
integer

The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer’s order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.

promotion_id
string

Promotion unique ID.

campaign
object

Contains details about promotion tier’s parent campaign.

campaign_id
string

Promotion tier’s parent campaign’s unique ID.

active
boolean

A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it’s within the active period defined by the start_date and expiration_date.

• true indicates an active promotion tier
• false indicates an inactive promotion tier

start_date
string

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

Example: 2022-09-23T00:00:00.000Z

expiration_date
string

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.

Example: 2022-09-26T00:00:00.000Z

validity_timeframe

validity_day_of_week

validity_hours

summary
object

Contains statistics about promotion tier redemptions and orders.

object
string

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

validation_rule_assignments

category_id
string

Promotion tier category ID.

Example: cat_0c9da30e7116ba6bba

categories
array

duration
string

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.

Example: PT1H

interval
string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.

Example: P2D

daily
array

object
string

The type of the object represented by JSON. This object stores information about validation rule assignments.

data_ref
string

Identifies the name of the JSON property that contains the array of validation rule assignments.

data
array

total
integer

Total number of validation rule assignments.

id
string

Unique category ID assigned by Voucherify.

name
string

Category name.

hierarchy
integer

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

object
string

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

Available values: category

created_at
string

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

Example: 2022-07-14T10:45:13.156Z

updated_at
string

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

Example: 2022-08-16T10:52:08.094Z

type
string

Defines the type of the voucher.

Available values: AMOUNT

amount_off
number

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.

amount_off_formula
string

Formula used to dynamically calculate the discount.

aggregated_amount_limit
integer

Maximum discount amount per order.

effect

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

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

type
string

Discount type.

Available values: UNIT

unit_off
integer

Number of units to be granted a full value discount.

unit_off_formula
string

Formula used to dynamically calculate the number of units.

effect

Defines how the unit is added to the customer’s order.

unit_type
string

The product deemed as free, chosen from product inventory (e.g. time, items).

product

Contains information about the product.

sku

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

type
string

Discount type.

Available values: UNIT

effect
string

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

Available values: ADD_MANY_ITEMS

units
array

type
string

Defines the type of the voucher.

Available values: PERCENT

percent_off
number

The percent discount that the customer will receive.

percent_off_formula
string

Formula used to dynamically calculate the discount.

amount_limit
number

Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.

aggregated_amount_limit
integer

Maximum discount amount per order.

effect

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

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

type
string

Defines the type of the voucher.

Available values: FIXED

fixed_amount
number

Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the fixed_amount_formula parameter is present in the fixed amount definition, this value becomes the fallback value. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.

fixed_amount_formula
string

Formula used to dynamically calculate the discount.

effect

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

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

id
string

Validation rule assignment ID.

Example: asgm_74F7QZoYbUoljwQO

rule_id
string

Validation rule ID.

Example: val_4j7DCRm2IS59

related_object_id
string

The resource ID to which the validation rule was assigned.

Example: v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT

related_object_type
string

The type of resource to which the validation rule was assigned.

Available values: voucher, campaign, earning_rule, reward_assignment, promotion_tier, distribution

created_at
string

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

Example: 2022-02-17T08:18:15.085Z

object
string

The type of the object represented by the ID.

Available values: validation_rules_assignment

id
string

Unique product ID, assigned by Voucherify.

source_id
string

Product’s source ID.

name
string

Product name.

id
string

Unique SKU ID, assigned by Voucherify.

source_id
string

Product variant’s source ID.

name
string

Sku name

unit_off
number

Number of units to be granted a full value discount.

unit_off_formula
string

Formula used to dynamically calculate the number of units.

effect
string

Defines how the unit is added to the customer’s order.

Available values: ADD_NEW_ITEMS, ADD_MISSING_ITEMS

unit_type
string

The product deemed as free, chosen from product inventory (e.g. time, items).

product

Contains information about the product.

sku

Contains information about the sku.