Refund

Each entry of order.refunds[]. The top-level refund template variable (present only on refund emails) uses the same shape.

Fields

Field Type Notes
amount number
comment string Optional.
creditNoteNumber string Optional — the refund's sequential credit note number; absent when credit note numbering isn't active.
notifyCustomer boolean
refundedByPaymentGateway boolean
creationDate datetime

Was this article helpful?