Voucher

Whenever you're dealing with a vouchers in your template, you're actually working with a Voucher object.

Attributes #

Attribute Description
id ID of the voucher.
title The voucher name/title.
name The voucher name/title.
url The URL to this single voucher.
purchasableId Returns this vouchers id - as vouchers are purchasables.
type The voucher's product type.
typeId The voucher's voucher type ID
price The listing price of the voucher.
customAmount Whether this voucher should have a custom (user-provided) amount.
sku The sku of the voucher.
status live, pending or expired based on postDate and expiryDate dates. Pending are vouchers with a future postDate date.
enabled true or false
taxCategoryId The ID for the tax category this voucher uses when their tax calculations are made.
taxCategory The tax category this voucher uses when their tax calculations are made.
shippingCategoryId The ID for the shipping category this voucher uses when their shipping calculations are made.
shippingCategory The shipping category this voucher uses when their shipping calculations are made.
postDate The date this voucher is available for sale.
expiryDate The date this voucher will no longer be available for sale.

Methods #

Method Description
getCpEditUrl() The url to edit this voucher in the control panel.
getPdfUrl(LineItem $lineItem, $option = null) Get the PDF URL for this voucher and Line Item.
getCodes(LineItem $lineItem) Get all Code's for a provided Line Item and voucher.
getProduct() Convenience method for native Commerce product behaviour.

Get started with Gift Voucher

Available for Craft 2 & Craft 3.