Emails. Done.

Template Stable

Payment failed

Sent when a payment attempt fails.

payment-failed - billing

v1
billing Stable Latest stable

Payment failed v1

payment-failed - v1

Subject: Payment failed

Preheader: Update your payment details to continue.

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		 Update payment
actionNote text No Action Note
Max 1000 characters		 Update your payment details to continue.
footerNote text No Footer Note
Max 1000 characters		 If you have already updated your payment details, no further action is needed.
heading text No Heading
Max 180 characters		 Payment failed
intro text No Intro
Max 1000 characters		 We could not complete your latest payment.
paymentDetails detailsTable No Payment details
Details table keys: amount (currency), dueDate (date), paymentMethod, reason		 {"amount":"Amount","dueDate":"Due Date","paymentMethod":"Payment Method","reason":"Reason"}
preheader text No Preheader
Max 220 characters		 Update your payment details to continue.
subject text No Subject
Max 180 characters		 Payment failed

Defaults

{
  "actionButton.label": "Update payment",
  "actionNote": "Update your payment details to continue.",
  "footerNote": "If you have already updated your payment details, no further action is needed.",
  "heading": "Payment failed",
  "intro": "We could not complete your latest payment.",
  "preheader": "Update your payment details to continue.",
  "subject": "Payment failed"
}

Example data

{
  "templateId": "payment-failed",
  "data": {
    "actionButton": {
      "url": "https://example.com/app"
    }
  }
}

Template messages

TypeCodeMessage
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 Action Note must be 1000 characters or fewer.
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 invalid_details_table Payment 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.