Skip to main content

CheckoutVoucher Object

Description​

Voucher information applied to a checkout.

Declaration​

type CheckoutVoucher {
id: String
value: String
originalValue: String
redeemType: String
redeemed: Boolean
expires: Date
unlimited: Boolean
user: CheckoutUser
created: Date
note: CheckoutNote
}

Fields​

NameTypeDescription
idStringVoucher identifier string.
valueStringCurrent value of the voucher after redemption.
originalValueStringOriginal value of the voucher before redemption.
redeemTypeStringType of voucher redemption (e.g., "percentage", "fixed").
redeemedBooleanWhether the voucher has been redeemed.
expiresDateExpiration date of the voucher.
unlimitedBooleanWhether the voucher has unlimited uses.
userCheckoutUserUser who owns or used the voucher.
createdDateDate when the voucher was created.
noteCheckoutNoteNote associated with the voucher.