| 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 |
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 |
Defines the type of the voucher. |
[optional] |
| discount |
\OpenAPI\Client\Model\Discount |
|
[optional] |
| gift |
\OpenAPI\Client\Model\VoucherGift |
|
[optional] |
| loyalty_card |
\OpenAPI\Client\Model\VoucherLoyaltyCard |
|
[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\VoucherValidityTimeframe |
|
[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 |
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] |
| is_referral_code |
bool |
Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. |
[optional] |
| created_at |
\DateTime |
Timestamp representing the date and time when the voucher was created in ISO 8601 format. |
[optional] |
| updated_at |
\DateTime |
Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. |
[optional] |
| holder_id |
string |
Unique customer ID of voucher owner. |
[optional] |
| holder |
\OpenAPI\Client\Model\SimpleCustomer |
|
[optional] |
| object |
string |
The type of object represented by JSON. Default is `voucher`. |
[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\VoucherPublish |
|
[optional] |
| redemption |
\OpenAPI\Client\Model\VoucherRedemption |
|
[optional] |