Retrieve an invoice

curl --request GET \
  --url https://api.taberna.io/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.taberna.io/v1/invoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taberna.io/v1/invoices/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taberna.io/v1/invoices/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taberna.io/v1/invoices/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "7Kq2mVn8pRt3XwYz5Bd4L",
  "number": 1042,
  "status": "open",
  "url": "https://taberna.io/invoice/7Kq2mVn8pRt3XwYz5Bd4L",
  "items": [
    {
      "name": "Design retainer — July",
      "description": "<string>",
      "quantity": 1,
      "unitAmount": "49.99",
      "amount": "49.99"
    }
  ],
  "totalAmount": "49.99",
  "currency": "usd",
  "customerName": "Acme GmbH",
  "customerEmail": "billing@acme.example",
  "memo": "Net 14. Thanks!",
  "metadata": {
    "ledgerRef": "INV-2026-1042"
  },
  "successUrl": "https://example.com/thanks",
  "cancelUrl": "https://example.com/billing",
  "createdVia": "api",
  "expiresAt": "2026-07-29T14:30:00.000Z",
  "paidAt": "2026-07-29T14:30:00.000Z",
  "voidedAt": "2026-07-29T14:30:00.000Z",
  "createdAt": "2026-07-29T14:30:00.000Z",
  "email": {
    "sendCount": 1,
    "sendsRemaining": 2,
    "maxSends": 3,
    "lastSentAt": "2026-07-29T14:30:00.000Z",
    "cooldownUntil": "2026-07-29T14:30:00.000Z",
    "canSend": true,
    "blockedReason": "Cooldown in effect"
  },
  "transactions": [
    {
      "blockchain": "base",
      "txHash": "0x3d7f2b91c4e08a5619d3fb27ac60e845912f7b3d0c6a48e152b9df3706ac81be",
      "fromAddress": "<string>",
      "amount": "1250000000",
      "blockNumber": "21847391",
      "blockTime": "2026-07-29T14:30:00.000Z"
    }
  ]
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

GET

invoices

{id}

Retrieve an invoice

curl --request GET \
  --url https://api.taberna.io/v1/invoices/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.taberna.io/v1/invoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taberna.io/v1/invoices/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taberna.io/v1/invoices/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taberna.io/v1/invoices/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "7Kq2mVn8pRt3XwYz5Bd4L",
  "number": 1042,
  "status": "open",
  "url": "https://taberna.io/invoice/7Kq2mVn8pRt3XwYz5Bd4L",
  "items": [
    {
      "name": "Design retainer — July",
      "description": "<string>",
      "quantity": 1,
      "unitAmount": "49.99",
      "amount": "49.99"
    }
  ],
  "totalAmount": "49.99",
  "currency": "usd",
  "customerName": "Acme GmbH",
  "customerEmail": "billing@acme.example",
  "memo": "Net 14. Thanks!",
  "metadata": {
    "ledgerRef": "INV-2026-1042"
  },
  "successUrl": "https://example.com/thanks",
  "cancelUrl": "https://example.com/billing",
  "createdVia": "api",
  "expiresAt": "2026-07-29T14:30:00.000Z",
  "paidAt": "2026-07-29T14:30:00.000Z",
  "voidedAt": "2026-07-29T14:30:00.000Z",
  "createdAt": "2026-07-29T14:30:00.000Z",
  "email": {
    "sendCount": 1,
    "sendsRemaining": 2,
    "maxSends": 3,
    "lastSentAt": "2026-07-29T14:30:00.000Z",
    "cooldownUntil": "2026-07-29T14:30:00.000Z",
    "canSend": true,
    "blockedReason": "Cooldown in effect"
  },
  "transactions": [
    {
      "blockchain": "base",
      "txHash": "0x3d7f2b91c4e08a5619d3fb27ac60e845912f7b3d0c6a48e152b9df3706ac81be",
      "fromAddress": "<string>",
      "amount": "1250000000",
      "blockNumber": "21847391",
      "blockTime": "2026-07-29T14:30:00.000Z"
    }
  ]
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

{
  "error": "Order not found"
}

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

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.

An invoice, plus the on-chain transfers that paid it.

string

required

The 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"

number

integer

required

Human-facing invoice number, counting up per store from 1. Distinct from id, which is what the API and the payment link use.

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

1042

status

enum<string>

required

Where the invoice is in its lifecycle. open — issued and payable. paid — settled in full. partial — funds arrived but fell short. expired — the payment window closed unpaid. voided — cancelled by the merchant, no longer payable.

Available options:

open,

paid,

partial,

expired,

voided

Example:

"open"

url

string

required

The hosted payment page for this invoice — what a customer opens to pay it.

Example:

"https://taberna.io/invoice/7Kq2mVn8pRt3XwYz5Bd4L"

items

object[]

required

The billed lines, in the order they were entered.

Show child attributes

totalAmount

string

required

Sum of every line. Decimal string in the resource's fiat currency, e.g. "49.99" — a string, never a JSON number, so no precision is lost in transit.

Example:

"49.99"

currency

enum<string>

required

The fiat currency every amount on this resource is priced in. Crypto is quoted against it at payment time.

Available options:

usd,

eur

Example:

"usd"

customerName

string | null

required

Who the invoice is addressed to, shown on the payment page. Null when unset.

Example:

"Acme GmbH"

customerEmail

string | null

required

The only address the send endpoint will email; it cannot be overridden per send. Null when unset, which also makes the invoice unsendable.

Example:

"billing@acme.example"

memo

string | null

required

Free-text note shown to the customer on the payment page. Null when unset.

Example:

"Net 14. Thanks!"

metadata

object | null

required

The arbitrary JSON object you attached at creation, returned untouched. Merchant-only: it never reaches the customer's payment page.

Show child attributes

Example:

{ "ledgerRef": "INV-2026-1042" }

successUrl

string | null

required

Where the payment page sends the customer once the invoice is paid. Null when none was set.

Example:

"https://example.com/thanks"

cancelUrl

string | null

required

Where the payment page sends the customer if they back out. Null when none was set.

Example:

"https://example.com/billing"

createdVia

enum<string>

required

Where the invoice came from. api — this API. dashboard — a human created it in the Taberna dashboard.

Available options:

api,

dashboard

Example:

"api"

expiresAt

string<date-time>

required

When the invoice stops accepting payment. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

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

paidAt

string<date-time> | null

required

When the invoice was settled in full. Null until it is. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

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

voidedAt

string<date-time> | null

required

When the merchant voided the invoice. Null unless voided. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

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

createdAt

string<date-time>

required

When the invoice was issued. UTC timestamp in ISO 8601, e.g. 2026-07-29T14:30:00.000Z.

Example:

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

object

required

The invoice's remaining email allowance.

Show child attributes

transactions

object[]

required

Every on-chain transfer that paid this invoice, across all of its payment attempts, oldest first.

Show child attributes

Orders

Invoices

Invoice Templates

Products

Store

Webhook Deliveries

Checkout

Retrieve an invoice

Authorizations

Path Parameters

Response