Name | Type | Description | Notes |
---|---|---|---|
id | string | [optional] | |
code | string | [optional] | |
campaign | string | A unique campaign name, identifies the voucher's parent campaign. | [optional] |
campaign_id | string | [optional] | |
category | string | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. | [optional] |
category_id | string | Unique category ID assigned by Voucherify. | [optional] |
categories | \OpenAPI\Client\Model\Category[] | Contains details about the category. | [optional] |
type | string | [optional] | |
discount | \OpenAPI\Client\Model\Discount | [optional] | |
gift | \OpenAPI\Client\Model\CustomerActivityDataRedemptionRewardVoucherGift | [optional] | |
loyalty_card | \OpenAPI\Client\Model\CustomerActivityDataRedemptionRewardVoucherLoyaltyCard | [optional] | |
start_date | \DateTime | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. | [optional] |
expiration_date | \DateTime | Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. | [optional] |
validity_timeframe | \OpenAPI\Client\Model\CustomerActivityDataRedemptionRewardVoucherValidityTimeframe | [optional] | |
validity_day_of_week | int[] | 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] |
active | bool | 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 | [optional] | |
assets | \OpenAPI\Client\Model\VoucherAssets | [optional] | |
is_referral_code | bool | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
created_at | string | [optional] | |
updated_at | \DateTime | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] |
holder_id | string | [optional] | |
holder | \OpenAPI\Client\Model\SimpleCustomer | [optional] | |
object | string | [optional] [default to 'voucher'] | |
distributions | object[] | [optional] | |
deleted | bool | Flag indicating whether this voucher is deleted. | [optional] |
validation_rules_assignments | \OpenAPI\Client\Model\ValidationRulesAssignmentsList | [optional] | |
publish | \OpenAPI\Client\Model\CustomerActivityDataRedemptionRewardVoucherPublish | [optional] | |
redemption | \OpenAPI\Client\Model\CustomerActivityDataRedemptionRewardVoucherRedemption | [optional] | |
referrer_id | string | Unique referrer ID. | [optional] |
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.