Emails. Done.

Template Stable

Usage threshold

Sent when usage reaches a configured threshold.

usage-threshold - billing

v1
billing Stable Latest stable

Usage threshold v1

usage-threshold - v1

Subject: Usage threshold reached

Preheader: Your usage has reached a configured threshold.

Required fields

Name Type Required Description Example
message text Yes Message
Max 1000 characters		 Your usage has reached a configured threshold.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 View usage
actionButton.url url No Action Button URL
Max 2048 characters		 https://example.com/app
heading text No Heading
Max 180 characters		 Usage threshold reached
preheader text No Preheader
Max 220 characters		 Your usage has reached a configured threshold.
subject text No Subject
Max 180 characters		 Usage threshold reached
usageDetails detailsTable No Usage details
Details table keys: used (number), limit (number), percentage (number), periodEndsAt (date)		 {"used":"Used","limit":"Limit","percentage":"Percentage","periodEndsAt":"Period Ends At"}

Defaults

{
  "actionButton.label": "View usage",
  "heading": "Usage threshold reached",
  "message": "Your usage has reached a configured threshold.",
  "preheader": "Your usage has reached a configured threshold.",
  "subject": "Usage threshold reached"
}

Example data

{
  "templateId": "usage-threshold",
  "data": {
    "message": "Your usage has reached a configured threshold."
  }
}

Template messages

TypeCodeMessage
Return accepted Valid template data can be queued by the send endpoint.
Error missing_required_variable Message is required.
Error field_too_long Message must be 1000 characters or fewer.
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 Preheader must be 220 characters or fewer.
Error field_too_long Subject must be 180 characters or fewer.
Error invalid_details_table Usage details must be an object whose documented table keys are strings, numbers, or booleans.