Skip to main content
GET
Retrieve an invoice

Authorizations

x-api-key
string
header
required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Path Parameters

invoiceId
string<uuid>
required

Invoice UUID.

Response

The invoice, with its earnings breakdown.

id
string<uuid>
required
invoice_number
string
required

Human-readable, e.g. INV-2026-0142.

transaction_id
string<uuid> | null
required

Linked settled transaction, once paid.

session_id
string | null
required

Linked checkout.

amount
number
required

Currency units.

currency
string
required
payment_token
string
required

What the buyer paid (or will pay) with.

status
enum<string>
required

issued (created, not yet paid), paid (payment settled), or voided.

Available options:
issued,
paid,
voided
fiat_amount
number | null
required

EUR/USD equivalent, for stablecoin payments.

fiat_currency
enum<string> | null
required
Available options:
EUR,
USD,
null
exchange_rate
number | null
required

Rate applied at settlement.

exchange_rate_source
string | null
required
tax_rate
number | null
required

Applied rate, e.g. 19 for 19%.

tax_amount
number | null
required

Currency units.

tax_name
string | null
required

e.g. DE VAT.

tax_inclusive
boolean | null
required

Whether amount already includes tax.

merchant_name
string | null
required

Seller name on the document.

buyer_email
string | null
required
buyer_name
string | null
required
buyer_company
string | null
required
buyer_country
string | null
required

ISO 3166-1 alpha-2.

buyer_vat
string | null
required
tx_hash
string | null
required

On-chain hash, for crypto payments.

issued_at
string<date-time>
required
voided_at
string<date-time> | null
required
created_at
string<date-time>
required
earnings
object | null
required

Present only for a card/bank Merchant-of-Record sale with a linked, settled transaction. null otherwise.