SimpleVoucher.md

VoucherifySdk::SimpleVoucher

Properties

Name	Type	Description	Notes
id	String	A unique identifier that represents the voucher assigned by Voucherify.	[optional]
code	String	Voucher code.	[optional]
gift	Gift		[optional]
discount	Discount		[optional]
loyalty_card	SimpleLoyaltyCard		[optional]
type	String	Type of the voucher.	[optional]
campaign	String	Campaign name.	[optional]
campaign_id	String	Campaign unique ID.	[optional]
is_referral_code	Boolean	Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.	[optional]
holder_id	String	Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.	[optional]
referrer_id	String	Unique identifier of the referrer assigned by Voucherify.	[optional]
category_id	String	Unique identifier of the category that this voucher belongs to.	[optional]
categories	Array<Category>	Contains details about the category.	[optional]
active	Boolean	Shows whether the voucher is on or off. `true` indicates an active voucher and `false` indicates an inactive voucher.	[optional]
created_at	Time	Timestamp representing the date and time when the order was created in the ISO 8601 format.	[optional]
updated_at	Time	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	Time	Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.	[optional]
expiration_date	Time	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	String	The type of the object represented by JSON.	[optional][default to 'voucher']