Skip to main content
POST
Email an invoice

Authorizations

Authorization
string
header
required

A store API key, sent as Authorization: Bearer <key>. Live keys are prefixed tbrn_live_. Keys are minted per store in the dashboard with an explicit scope set.

Path Parameters

id
string
required
Pattern: ^[1-9A-HJ-NP-Za-km-z]{21,22}$

Response

The invoice was handed to the mailer.

invoiceId
string
required

Public short id — the value that appears in checkout links.

sentTo
string
required
sentAt
string<date-time>
required

ISO-8601 timestamp in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
sendCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
sendsRemaining
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
maxSends
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991