Response body schema for GET v1/vouchers/{code}
.
Name | Type | Description | Notes |
---|---|---|---|
id | str | Assigned by the Voucherify API, identifies the voucher. | [optional] |
code | str | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. | [optional] |
campaign | str | A unique campaign name, identifies the voucher's parent campaign. | [optional] |
campaign_id | str | Assigned by the Voucherify API, identifies the voucher's parent campaign. | [optional] |
category | str | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. | [optional] |
category_id | str | Unique category ID assigned by Voucherify. | [optional] |
type | str | Defines the type of the voucher. | [optional] |
discount | Discount | [optional] | |
gift | VouchersGetResponseBodyGift | [optional] | |
loyalty_card | VouchersGetResponseBodyLoyaltyCard | [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 | ValidityTimeframe | [optional] | |
validity_day_of_week | List[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] |
validity_hours | 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] |
additional_info | str | 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 | 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. The value is shown in the 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 | 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 referring person. | [optional] |
object | str | The type of the object represented by JSON. Default is `voucher`. | [optional] [default to 'voucher'] |
publish | VouchersGetResponseBodyPublish | [optional] | |
redemption | VouchersGetResponseBodyRedemption | [optional] | |
categories | List[Category] | Contains details about the category. | [optional] |
validation_rules_assignments | ValidationRulesAssignmentsList | [optional] |