Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 2.75 KB

File metadata and controls

43 lines (26 loc) · 2.75 KB

Voucherify.PromotionTierCreateParams

Properties

Name Type Description Notes
name String Name of the promotion tier. [optional]
banner String Text to be displayed to your customers on your website. [optional]
action PromotionTierCreateParamsAction [optional]
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. [optional]
validationRules [String] Array containing the ID of the validation rule associated with the promotion tier. [optional]
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 [optional]
hierarchy Number 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. [optional]
startDate Date Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date. [optional]
expirationDate Date Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date. [optional]
validityTimeframe ValidityTimeframe [optional]
validityDayOfWeek [Number] Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday [optional]
validityHours ValidityHours [optional]
category String Assign category to the promotion tier. [optional]
categoryId String Instead of using the category name, you can alternatively assign a new category to a promotion tier using a unique category ID, i.e. `cat_0c9da30e7116ba6bba`. [optional]

Enum: [ValidityDayOfWeekEnum]

  • 0 (value: 0)

  • 1 (value: 1)

  • 2 (value: 2)

  • 3 (value: 3)

  • 4 (value: 4)

  • 5 (value: 5)

  • 6 (value: 6)