Simplified voucher data.
Name | Type | Description | Notes |
---|---|---|---|
id | str | A unique identifier that represents the voucher assigned by Voucherify. | [optional] |
code | str | Voucher code. | [optional] |
gift | Gift | [optional] | |
discount | Discount | [optional] | |
loyalty_card | SimpleLoyaltyCard | [optional] | |
type | str | Type of the voucher. | [optional] |
campaign | str | Campaign name. | [optional] |
campaign_id | str | Campaign unique ID. | [optional] |
is_referral_code | bool | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
holder_id | str | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. | [optional] |
referrer_id | str | Unique identifier of the referrer assigned by Voucherify. | [optional] |
category_id | str | Unique identifier of the category that this voucher belongs to. | [optional] |
categories | List[Category] | Contains details about the category. | [optional] |
active | bool | Shows whether the voucher is on or off. `true` indicates an active voucher and `false` indicates an inactive voucher. | [optional] |
created_at | datetime | Timestamp representing the date and time when the order was created in the ISO 8601 format. | [optional] |
updated_at | datetime | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
redemption | SimpleVoucherRedemption | [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] |
metadata | object | A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher. | [optional] |
object | str | The type of the object represented by JSON. | [optional] [default to 'voucher'] |