Get invoice

Fetch a single invoice you own, including its payment address, QR payment URI, and how much has been received so far.

GEThttps://triport.io/v1/billing/invoices/inv_8f2c1a7e9b3d4e6f

Network: — (per-invoice; the rail/network is returned in the body)
Auth: Session cookie (nl_session)

Request

cURLJavaScriptPython

curl https://triport.io/v1/billing/invoices/inv_8f2c1a7e9b3d4e6f \
  -H "Content-Type: application/json" \
  -b "nl_session=$TRIPORT_SESSION"

const res = await fetch("https://triport.io/v1/billing/invoices/inv_8f2c1a7e9b3d4e6f", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
  },
});
const data = await res.json();
console.log(data);

import requests


resp = requests.get(
    "https://triport.io/v1/billing/invoices/inv_8f2c1a7e9b3d4e6f",
    headers={
        "Content-Type": "application/json",
    },
)
data = resp.json()
print(data)

Response

JSON

Example

{
  "id": "inv_8f2c1a7e9b3d4e6f",
  "user_id": "usr_a13f29c4",
  "amount_micro": 49000000,
  "status": "pending",
  "description": "Growth plan — 3 months",
  "channel": "crypto-onchain",
  "rail": "polygon-usdc",
  "bill_action": {
    "type": "subscription_purchase",
    "plan": "growth",
    "months": 3
  },
  "client_request_id": "b6f0d2c1-7a44-4e2b-9f10-2c8e5d3a1b9e",
  "created_at": "2026-05-29T11:42:08Z",
  "expires_at": "2026-05-29T12:12:08Z",
  "amount_usd": "49.00",
  "address": {
    "invoice_id": "inv_8f2c1a7e9b3d4e6f",
    "network": "polygon",
    "address": "0x3a1F9C7b2E54d8A6f0B19c4D2e7A8b6C5d4E3f21",
    "deriv_index": 137
  },
  "qr_uri": "ethereum:0x3a1F9C7b2E54d8A6f0B19c4D2e7A8b6C5d4E3f21@137/transfer?address=0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174&uint256=49000000",
  "payments_received_micro": 0,
  "payer_address": null,
  "payer_linked": null
}

Returns the full state of one invoice belonging to the authenticated user. Use it to render an invoice/checkout screen: the response carries the canonical status, the deposit address for the chosen rail, a ready-to-render qr_uri, and payments_received_micro so you can show progress toward the amount due.

This is the snapshot endpoint. For a live feed of status changes (payment detected, paid, expired, cancelled) open the SSE stream at GET /v1/billing/invoices/{id}/events instead of polling this route.

Invoices are scoped to their owner. Requesting an id that does not exist — or one that belongs to another user — returns 404 (the API does not distinguish the two cases, so it never leaks the existence of someone else's invoice).

Parameters

Path parameters

idstringrequired

The invoice ID (as returned by POST /v1/billing/invoices or GET /v1/billing/invoices).

Response

200 OK

idstring

Invoice ID.

user_idstring

Owner of the invoice.

amount_micronumber

Amount due, in micro-units (1_000_000 = 1.00 USD).

statusstring

One of pending, paid, expired, cancelled.

descriptionstring

Human-readable line item.

channelstring

Payment channel: crypto-onchain or crypto-inapp.

railstring

Payment rail, e.g. polygon-usdc, sol-spl-usdc, eth-usdt. See GET /v1/billing/rails.

bill_actionobject

What the payment buys: { type, plan, months } where type is subscription_purchase, subscription_renew, or topup.

client_request_idstring

Idempotency key supplied at creation (if any).

fx_rate_micro_per_atomicnumber

FX rate locked at creation, for rails that require one (if any).

reference_pubkeystring

On-chain reference key used to match payments (if any).

created_atstring

ISO-8601 creation time.

expires_atstring

ISO-8601 expiry; after this a pending invoice is swept to expired.

paid_atstring

ISO-8601 time the invoice was marked paid (present once paid).

processed_atstring

ISO-8601 time the bill action was applied (present once processed).

amount_usdstring

amount_micro formatted as a decimal USD string, e.g. "49.00".

addressobject

The single deposit address for this invoice (see below). May be absent if no address has been derived.

qr_uristring

Payment URI for the rail, suitable for rendering a QR code. Absent when the rail is unknown or no address exists.

payments_received_micronumber

Total received so far for this invoice, in micro-units.

payer_addressstring

null

payer_linkedboolean

null

Errors

Code	Meaning	When it happens
`401`	`auth required`	No valid `nl_session` cookie on the request.
`404`	`not found`	The invoice does not exist, or it is not owned by the requesting user.

All errors share the standard envelope { "error": "<message>" }. See errors.md for the full error model.

Examples

JavaScript (fetch)

JavaScript

async function getInvoice(id) {
  const r = await fetch(`https://triport.io/v1/billing/invoices/${id}`, {
    headers: { 'Content-Type': 'application/json' },
    credentials: 'include', // send the nl_session cookie
  });
  if (!r.ok) {
    const body = await r.json().catch(() => ({}));
    throw new Error(body.error || `HTTP ${r.status}`);
  }
  return r.json();
}


const invoice = await getInvoice('inv_8f2c1a7e9b3d4e6f');
console.log(invoice.status, invoice.amount_usd, invoice.address?.address);

Notes

Snapshot, not a stream. To react to payment in real time, subscribe to GET /v1/billing/invoices/{id}/events rather than polling this endpoint.
amount_usd vs amount_micro. amount_micro is the precise integer amount in micro-units; amount_usd is the same value pre-formatted for display. Compute progress from the *_micro fields, not the string.
Address availability. address and qr_uri are present for a normal per-rail invoice. If they are missing, the rail/address has not been resolved yet — re-fetch shortly or check the invoice was created against a valid rail.
Related endpoints: list invoices, create invoice, cancel invoice, pay from balance.