Email an invoice
Emails an open invoice to the address stored on it. Requires the invoices:write scope.
Takes no body: the recipient is always the invoice’s own customerEmail and cannot be overridden. Sends are capped per invoice, per store and platform-wide; the invoice’s email object reports the remaining allowance, and a rate-limited response carries a Retry-After header.
Authorizations
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
^[1-9A-HJ-NP-Za-km-z]{21,22}$Response
The invoice was handed to the mailer.
Public short id — the value that appears in checkout links.
ISO-8601 timestamp in UTC.
^(?:(?:\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))$-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991-9007199254740991 <= x <= 9007199254740991