Name | Type | Description | Notes |
---|---|---|---|
id | String | Assigned by the Voucherify API, identifies the voucher. | |
code | String | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. | |
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 | 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. | |
categories | Array<Category> | [optional] | |
type | String | Defines the type of the voucher. | [default to 'LOYALTY_CARD'] |
loyalty_card | LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard | ||
start_date | Time | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. | |
expiration_date | Time | Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. | |
validity_timeframe | LoyaltiesMembersTransfersCreateResponseBodyValidityTimeframe | ||
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 | |
publish | LoyaltiesMembersTransfersCreateResponseBodyPublish | [optional] | |
redemption | LoyaltiesMembersTransfersCreateResponseBodyRedemption | [optional] | |
active | String | 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 | LoyaltiesMembersTransfersCreateResponseBodyAssets | [optional] | |
is_referral_code | Boolean | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | |
holder_id | String | Unique customer ID of voucher owner. | [optional] |
updated_at | Time | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] |
created_at | Time |