id
string

Assigned by the Voucherify API, identifies the voucher.

Example: v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV

code
string

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

Example: WVPblOYX

campaign
string

A unique campaign name, identifies the voucher’s parent campaign.

Example: Gift Card Campaign

campaign_id
string

Assigned by the Voucherify API, identifies the voucher’s parent campaign.

Example: camp_FNYR4jhqZBM9xTptxDGgeNBV

category
string

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

category_id
string

Unique category ID assigned by Voucherify.

Example: cat_0bb343dee3cdb5ec0c

type
string

Defines the type of the voucher.

Available values: GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD

discount

gift
object

Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.

loyalty_card
object

Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.

start_date
string

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

Example: 2021-12-01T00:00:00.000Z

expiration_date
string

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

Example: 2021-12-31T00:00:00.000Z

validity_timeframe

validity_day_of_week

validity_hours

active
boolean, null

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

• true indicates an active voucher
• false indicates an inactive voucher

additional_info
string

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

metadata
object

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

assets

is_referral_code
boolean, null

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

created_at
string

Timestamp representing the date and time when the voucher 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 voucher was last updated in ISO 8601 format.

Example: 2021-12-22T10:14:45.316Z

holder_id
string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Example: cust_eWgXlBBiY6THFRJwX45Iakv4

referrer_id
string

Unique identifier of the referring person.

Example: cust_Vzck5i8U3OhcEUFY6MKhN9Rv

object
string

The type of the object represented by JSON. Default is voucher.

publish
object

Stores a summary of publication events: an event counter and endpoint to return details of each event. Publication is an assignment of a code to a customer, e.g. through a distribution.

redemption
object

Stores a summary of redemptions that have been applied to the voucher.

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

object
string

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

Available values: list

data_ref
string

Identifies the name of the attribute that contains the array of validation rules assignments.

Available values: data

data
array

total
integer

Total number of validation rules assignments.

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

qr
object

Stores Quick Response (QR) representation of encrypted code.

barcode
object

Stores barcode representation of encrypted code.

id
string

The unique identifier for a assignment

rule_id
string

The unique identifier for a rule

related_object_id
string

The unique identifier for a related object

related_object_type
string

The type of related object

created_at
string

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

Example: 2022-03-09T11:19:04.819Z

updated_at
string

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

Example: 2022-03-09T11:19:04.819Z

object
string

The type of the object represented by JSON.

Available values: validation_rules_assignment

validation_status
string

The validation status of the assignment

Available values: VALID, PARTIALLY_VALID, INVALID

validation_omitted_rules
array

The list of omitted rules

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

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.