billing
Stable
Latest stable
Refund issued v1
refund-issued - v1
Subject: Refund issued
Preheader: A refund has been issued.
Required fields
No fields.
Optional fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
footerNote |
text | No | Footer Note Max 1000 characters |
Refund timing may depend on the payment method used. |
heading |
text | No | Heading Max 180 characters |
Refund issued |
intro |
text | No | Intro Max 1000 characters |
A refund has been issued. |
preheader |
text | No | Preheader Max 220 characters |
A refund has been issued. |
refundDetails |
detailsTable | No | Refund details Details table keys: amount (currency), issuedAt (date), paymentMethod, reference |
{"amount":"Amount","issuedAt":"Issued At","paymentMethod":"Payment Method","reference":"Reference"} |
subject |
text | No | Subject Max 180 characters |
Refund issued |
Defaults
{
"footerNote": "Refund timing may depend on the payment method used.",
"heading": "Refund issued",
"intro": "A refund has been issued.",
"preheader": "A refund has been issued.",
"subject": "Refund issued"
}
Example data
{
"templateId": "refund-issued",
"data": {}
}
Template messages
| Type | Code | Message |
|---|---|---|
| Return | accepted |
Valid template data can be queued by the send endpoint. |
| Error | field_too_long |
Footer Note must be 1000 characters or fewer. |
| Error | field_too_long |
Heading must be 180 characters or fewer. |
| Error | field_too_long |
Intro must be 1000 characters or fewer. |
| Error | field_too_long |
Preheader must be 220 characters or fewer. |
| Error | invalid_details_table |
Refund details must be an object whose documented table keys are strings, numbers, or booleans. |
| Error | field_too_long |
Subject must be 180 characters or fewer. |