billing
Stable
Latest stable
Invoice overdue v1
invoice-overdue - v1
Subject: Invoice overdue
Preheader: Payment is now overdue.
Required fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
actionButton.url |
url | Yes | Action Button URL Max 2048 characters |
https://example.com/app |
Optional fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
actionButton.label |
text | No | Action Button Label Max 120 characters |
Pay invoice |
heading |
text | No | Heading Max 180 characters |
Invoice overdue |
intro |
text | No | Intro Max 1000 characters |
Payment for this invoice is now overdue. |
invoiceDetails |
detailsTable | No | Invoice details Details table keys: invoiceNumber, amount (currency), dueDate (date), daysOverdue (number) |
{"invoiceNumber":"Invoice Number","amount":"Amount","dueDate":"Due Date","daysOverdue":"Days Overdue"} |
preheader |
text | No | Preheader Max 220 characters |
Payment is now overdue. |
subject |
text | No | Subject Max 180 characters |
Invoice overdue |
Defaults
{
"actionButton.label": "Pay invoice",
"heading": "Invoice overdue",
"intro": "Payment for this invoice is now overdue.",
"preheader": "Payment is now overdue.",
"subject": "Invoice overdue"
}
Example data
{
"templateId": "invoice-overdue",
"data": {
"actionButton": {
"url": "https://example.com/app"
}
}
}
Template messages
| Type | Code | Message |
|---|---|---|
| Return | accepted |
Valid template data can be queued by the send endpoint. |
| Error | missing_required_variable |
Action Button URL is required. |
| Error | field_too_long |
Action Button URL must be 2048 characters or fewer. |
| Error | invalid_url |
Action Button URL must be a valid http or https URL. |
| Error | field_too_long |
Action Button Label must be 120 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 | invalid_details_table |
Invoice details must be an object whose documented table keys are strings, numbers, or booleans. |
| Error | field_too_long |
Preheader must be 220 characters or fewer. |
| Error | field_too_long |
Subject must be 180 characters or fewer. |