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: Loyalty 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.

category_id
string

Unique category ID assigned by Voucherify.

Example: cat_0bb343dee3cdb5ec0c

categories
array

type
string

Defines the type of the voucher.

Available values: LOYALTY_CARD

discount
object, null

Object representing discount parameters. Child attributes are present only if type is DISCOUNT_VOUCHER. Defaults to null.

gift
object, null

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.

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

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
object

Stores links to images of QR and barcode that correspond to an encrypted voucher code.

is_referral_code
boolean

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

redemption
object

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

publish
object

This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or publish voucher API method.

object
string

The type of the object represented by JSON. Default is 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

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