Skip to main content
GET
Retrieve 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.

id
string
required

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

number
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
required
Available options:
open,
paid,
partial,
expired,
voided
url
string
required
items
object[]
required
totalAmount
string
required

Fiat amount as a decimal string, e.g. "9.99". Never a number.

currency
enum<string>
required
Available options:
usd,
eur
customerName
string | null
required
customerEmail
string | null
required
memo
string | null
required
metadata
object | null
required
successUrl
string | null
required
cancelUrl
string | null
required
createdVia
enum<string>
required
Available options:
api,
dashboard
expiresAt
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))$
paidAt
string<date-time> | null
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))$
voidedAt
string<date-time> | null
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))$
createdAt
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))$
email
object
required
transactions
object[]
required