Name | Type | Description | Notes |
---|---|---|---|
category | String | The name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint. | [optional] |
category_id | String | Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint. | [optional] |
start_date | Time | Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is inactive before this date. | [optional] |
expiration_date | Time | Expiration date defines when the code expires. Expiration timestamp is presented in the 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] |
type | String | [optional] | |
loyalty_card | SimpleLoyaltyCard | [optional] | |
gift | Gift | [optional] | |
discount | Discount | [optional] |