Skip to content
Log in

AppliedVoucher - Liquid Object Reference

On this page

Description

The Applied Voucher object contains information about vouchers that have been applied to the Cart.

Attributes

Attribute Type Description
amount Number Returns the amount of this voucher that has been applied to the cart
balance Number Returns the current balance of this voucher, before any amount has been applied
code String Returns the code of this voucher
id String Returns the unique id for this voucher
identifier String Returns the customer-facing identifier for this voucher: the code, or the masked card number for a gift card
label String Returns the display label for this voucher’s provider, for example Voucher or Gift card
provider String Returns the name of the voucher provider this voucher belongs to: sc or vii. See VoucherProvider.
state String Returns the current redemption state of this voucher. See State values.

State values

Value Description
applied The voucher has been successfully applied to the cart.
requires_pin The voucher has a PIN but none was provided. Prompt the customer to enter their PIN.
invalid_pin A PIN was provided but it did not match the voucher’s PIN. Prompt the customer to try again.

Available on

Was this article helpful?

Was this article helpful?