SimpleVoucher.md

SimpleVoucher

Simplified voucher data.

Properties

Name	Type	Description
id	String	A unique identifier that represents the voucher assigned by Voucherify.
code	String	Voucher code.
gift	Gift
discount	Discount
loyaltyCard	SimpleVoucherLoyaltyCard
type	TypeEnum	Type of the voucher.
campaign	String	Campaign name.
campaignId	String	Campaign unique ID.
isReferralCode	Boolean	Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.
holderId	String	Unique customer ID of the campaign owner.
referrerId	String	Unique identifier of the referrer assigned by Voucherify.
categoryId	String	Unique identifier of the category that this voucher belongs to.
categories	List<Category>	Contains details about the category.
active	Boolean	Shows whether the voucher is on or off. `true` indicates an active voucher and `false` indicates an inactive voucher.
createdAt	OffsetDateTime	Timestamp representing the date and time when the order was created. Timestamp is presented in the ISO 8601 format.
updatedAt	OffsetDateTime	Timestamp representing the date and time when the voucher was updated in the ISO 8601 format.
redemption	SimpleVoucherRedemption
startDate	OffsetDateTime	Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
expirationDate	OffsetDateTime	Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
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.
_object	ObjectEnum	The type of the object represented by JSON.

Enum: TypeEnum

Name	Value
DISCOUNT_VOUCHER	"DISCOUNT_VOUCHER"
LOYALTY_CARD	"LOYALTY_CARD"
GIFT_VOUCHER	"GIFT_VOUCHER"

Enum: ObjectEnum

Name	Value
VOUCHER	"voucher"