60 lines (36 loc) · 1.79 KB

RedeemableHolder

Single customer's redeemable

Properties

Name	Type	Description
id	String	Unique identifier of the redeemable holder.
createdAt	OffsetDateTime	Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format.
redeemableId	String	Identifier of the redeemable item.
redeemableObject	String	Type of the redeemable.
customerId	String	Unique identifier of the customer.
holderRole	HolderRoleEnum	Role of the holder.
campaignId	String	Unique identifier of the campaign as assigned by Voucherify.
campaignType	CampaignTypeEnum	Defines the type of the campaign.
voucherType	VoucherTypeEnum	Defines the type of the voucher.
metadata	Object	A set of custom key/value pairs that you can attach to a redeemable holder. The metadata object stores all custom attributes assigned to the `redeemable_holder` object.
_object	ObjectEnum	The type of the object represented by JSON.

Enum: HolderRoleEnum

Name	Value
OWNER	"OWNER"
REFERRER	"REFERRER"
REFEREE	"REFEREE"

Enum: CampaignTypeEnum

Name	Value
REFERRAL_PROGRAM	"REFERRAL_PROGRAM"

Enum: VoucherTypeEnum

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

Enum: ObjectEnum

Name	Value
REDEEMABLE_HOLDER	"redeemable_holder"