Emails. Done.

Template Stable

Payment succeeded

Sent when a payment succeeds.

payment-succeeded - billing

v1
billing Stable Latest stable

Payment succeeded v1

payment-succeeded - v1

Subject: Payment received

Preheader: Your payment was successful.

Required fields

No fields.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 View receipt
actionButton.url url No Action Button URL
Max 2048 characters		 https://example.com/app
heading text No Heading
Max 180 characters		 Payment received
intro text No Intro
Max 1000 characters		 Your payment was successful.
paymentDetails detailsTable No Payment details
Details table keys: amount (currency), paidAt (datetime), paymentMethod, reference		 {"amount":"Amount","paidAt":"Paid At","paymentMethod":"Payment Method","reference":"Reference"}
preheader text No Preheader
Max 220 characters		 Your payment was successful.
subject text No Subject
Max 180 characters		 Payment received

Defaults

{
  "actionButton.label": "View receipt",
  "heading": "Payment received",
  "intro": "Your payment was successful.",
  "preheader": "Your payment was successful.",
  "subject": "Payment received"
}

Example data

{
  "templateId": "payment-succeeded",
  "data": {}
}

Template messages

TypeCodeMessage
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 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.