| 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] |
| campaignId |
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. |
[optional] |
| categoryId |
string |
Unique category ID assigned by Voucherify. |
[optional] |
| type |
string |
Defines the type of the voucher. |
[optional] |
| discount |
\OpenAPI\Client\Model\Discount |
|
[optional] |
| gift |
\OpenAPI\Client\Model\RedemptionEntryVoucherGift |
|
[optional] |
| loyaltyCard |
\OpenAPI\Client\Model\RedemptionEntryVoucherLoyaltyCard |
|
[optional] |
| startDate |
\DateTime |
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. |
[optional] |
| expirationDate |
\DateTime |
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. |
[optional] |
| validityTimeframe |
\OpenAPI\Client\Model\ValidityTimeframe |
|
[optional] |
| validityDayOfWeek |
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] |
| validityHours |
\OpenAPI\Client\Model\ValidityHours |
|
[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] |
| additionalInfo |
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 |
\OpenAPI\Client\Model\VoucherAssets |
|
[optional] |
| isReferralCode |
bool |
Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. |
[optional] |
| createdAt |
\DateTime |
Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. |
[optional] |
| updatedAt |
\DateTime |
Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. |
[optional] |
| holderId |
string |
Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. |
[optional] |
| referrerId |
string |
Unique identifier of the referring person. |
[optional] |
| object |
string |
The type of the object represented by JSON. Default is `voucher`. |
[optional] [default to 'voucher'] |
| publish |
\OpenAPI\Client\Model\RedemptionEntryVoucherPublish |
|
[optional] |
| redemption |
\OpenAPI\Client\Model\RedemptionEntryVoucherRedemption |
|
[optional] |
| categories |
\OpenAPI\Client\Model\Category[] |
Contains details about the category. |
[optional] |
| validationRulesAssignments |
\OpenAPI\Client\Model\ValidationRulesAssignmentsList |
|
[optional] |
| holder |
\OpenAPI\Client\Model\SimpleCustomer |
|
[optional] |