Voucher Object Fields

Read about what fields you can use to model vouchers.

FieldDescription
voucher_typeType of the voucher.
voucher_codeVoucher code. If present, it is displayed on the invoice.
voucher_descriptionA custom voucher description. It is not displayed on the invoice.
voucher_amountThe voucher amount can be greater than the transaction total amount.

If this is the case, the total_billable_amount is 0 and the voucher_applied_amount and voucher_remaining_amount fields will indicate how much of the voucher has been spent and remains.