Name | Type | Description | Notes |
---|---|---|---|
id | String | Assigned by the Voucherify API, identifies the voucher. | [optional] |
code | String | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. | [optional] |
campaign | String | A unique campaign name, identifies the voucher's parent campaign. | [optional] |
campaign_id | String | Assigned by the Voucherify API, identifies the voucher's parent campaign. | [optional] |
category | String | The value is null. | [optional] |
category_id | String | Unique category ID assigned by Voucherify. | [optional] |
categories | Array<Object> | Contains an empty array. | [optional] |
type | String | Defines the type of the voucher. | [optional] |
discount | Discount | [optional] | |
gift | RedeemableVoucherGift | [optional] | |
loyalty_card | RedeemableVoucherLoyaltyCard | [optional] | |
start_date | Time | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. | [optional] |
expiration_date | Time | Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. | [optional] |
validity_timeframe | ValidityTimeframe | [optional] | |
validity_day_of_week | Array<Integer> | 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] |
validity_hours | ValidityHours | [optional] | |
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 | [optional] |
additional_info | String | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
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. | [optional] |
assets | VoucherAssets | [optional] | |
is_referral_code | Boolean | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
created_at | Time | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] |
updated_at | Time | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] |
referrer_id | String | Unique identifier of the referring person. | [optional] |
holder_id | String | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. | [optional] |
object | String | The type of the object represented by JSON. Default is `voucher`. | [optional][default to 'voucher'] |
publish | RedeemableVoucherPublish | [optional] | |
redemption | RedeemableVoucherRedemption | [optional] |