Skip to main content
POST
Email an invoice

Authorizations

Authorization
string
header
required

A store API key, sent as Authorization: Bearer <key>.

A key looks like tbrn_live_ followed by 48 hex characters, e.g. tbrn_live_4f2a...c91b. Mint one in the Taberna dashboard under Developers → API Keys, tick the scopes the integration needs, and copy it there and then — the full value is shown once and only its hash is stored, so a lost key is replaced rather than recovered.

One key belongs to one store and carries a fixed scope set. Send it from a server, never from a browser: it can create orders and invoices and read every order the store has.

Path Parameters

id
string
required

The invoice to act on. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.

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

"7Kq2mVn8pRt3XwYz5Bd4L"

Response

The invoice was handed to the mailer.

Confirmation that an invoice email was accepted for delivery.

invoiceId
string
required

The emailed invoice's id. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.

Example:

"7Kq2mVn8pRt3XwYz5Bd4L"

sentTo
string
required

The address the invoice went to — always the invoice's own customerEmail.

Example:

"billing@acme.example"

sentAt
string<date-time>
required

When the send was handed to the mail provider. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

"2026-07-29T14:30:00.000Z"

sendCount
integer
required

How many times this invoice has now been emailed.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2

sendsRemaining
integer
required

Sends left before the per-invoice cap.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

maxSends
integer
required

The per-invoice cap on emails.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

3