billing
Stable
Latest stable
Subscription cancelled v1
subscription-cancelled - v1
Subject: Subscription cancelled
Preheader: Your subscription has been cancelled.
Required fields
No fields.
Optional fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
actionButton.label |
text | No | Action Button Label Max 120 characters |
Manage subscription |
actionButton.url |
url | No | Action Button URL Max 2048 characters |
https://example.com/app |
heading |
text | No | Heading Max 180 characters |
Subscription cancelled |
intro |
text | No | Intro Max 1000 characters |
Your subscription has been cancelled. |
preheader |
text | No | Preheader Max 220 characters |
Your subscription has been cancelled. |
subject |
text | No | Subject Max 180 characters |
Subscription cancelled |
subscriptionDetails |
detailsTable | No | Subscription details Details table keys: cancelledAt (date), accessEndsAt (date), plan |
{"cancelledAt":"Cancelled At","accessEndsAt":"Access Ends At","plan":"Plan"} |
Defaults
{
"actionButton.label": "Manage subscription",
"heading": "Subscription cancelled",
"intro": "Your subscription has been cancelled.",
"preheader": "Your subscription has been cancelled.",
"subject": "Subscription cancelled"
}
Example data
{
"templateId": "subscription-cancelled",
"data": {}
}
Template messages
| Type | Code | Message |
|---|---|---|
| Return | accepted |
Valid template data can be queued by the send endpoint. |
| Error | field_too_long |
Action Button Label must be 120 characters or fewer. |
| 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 |
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 | field_too_long |
Subject must be 180 characters or fewer. |
| Error | invalid_details_table |
Subscription details must be an object whose documented table keys are strings, numbers, or booleans. |