One invoice
One invoice by id, with its lines, payment status and refunds. Another workspace's invoice is 404.
Authorization
apiKey Authorization: Bearer fx_live_<id>_<secret>.
A key is shown once, at creation. We cannot show it again or recover it for you.
Keys carry a label (live or test) in the key itself, so each configuration is easy to tell
apart. Both reach real brokers: test with a broker demo account.
Scopes are per key. A key without accounts:write can read accounts and nothing else.
In: header
Path Parameters
uuidResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/billing/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": "string", "plan": "string", "method": "card", "status": "open", "currency": "string", "amount": 0, "amountRefunded": 0, "periodStart": null, "periodEnd": null, "crypto": null, "note": null, "paidAt": null, "createdAt": "2019-08-24T14:15:22Z" }}Invoices, newest first GET
Every invoice for this workspace, newest first, with its number, amount, status, provider and any refunds. Amounts are in minor units.
The available plans GET
The plans on offer now: what each includes and what it costs. Prices are in minor units — `9900` is $99.00, never a float. `accounts` is a capacity limit: you cannot exceed it and be billed for the excess. The monthly allowances can run over where the plan allows it, up to twice the allowance, after which orders are refused — a runaway strategy should not be able to generate an unbounded invoice.