Refunds email template

This template is sent whenever a refund is applied to an existing order.

When building your refund template, you have access to the refund being issued and the order it belongs to.

The template receives:

Variable Type Notes
context string Email, Pdf or Html.
settings object Store settings — see Settings.
order Order The order the refund applies to.
refund Refund The refund being issued.

What you can access

Path Type
refund Refund
order Order
order.items[] Item
order.billingAddress Address
order.shippingAddress Address
order.summary Summary
order.summary.taxes[] Tax
order.discounts[] Discount
order.customFields[] CustomField
order.refunds[] Refund

Minimal example

{
  "context": "Email",
  "settings": { "businessAddress": { "company": "snipcart.com" } },
  "refund": {
    "amount": 20,
    "comment": "Refunded after speaking with customer.",
    "notifyCustomer": false
  },
  "order": {
    "invoiceNumber": "SNIP-1001",
    "email": "john.doe@example.com",
    "items": [{ "name": "Geek T-Shirt", "quantity": 2, "totalPrice": 100 }],
    "summary": { "total": 120 }
  }
}

Was this article helpful?