Docs
Billing

This month's usage and what it would cost

GET
/v1/billing/usage

Counted as it happens rather than derived at the end of the month, so this is the same number the invoice will use.

Over quota, opening is refused and closing is always allowed. A billing problem must never hold you in a position you cannot exit — an order to close comes back 201 however far over the plan you are, and only opening returns 402 QUOTA_EXCEEDED.

Authorization

apiKey
AuthorizationBearer <token>

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 an environment (live or test) in the key itself, so a test key pasted into a production config fails immediately instead of at the worst possible moment.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/billing/usage"
{  "data": {    "plan": "string",    "planName": "string",    "currency": "string",    "subtotal": null,    "overage": 0,    "total": null,    "entitlements": {      "accounts": 0,      "ordersPerMonth": 0,      "wavesPerMonth": 0,      "legsPerWave": 0,      "apiCallsPerMonth": 0,      "allowOverage": true    },    "features": {      "executionWaves": true,      "pendingOrders": true,      "alwaysOn": true,      "webhooks": true    },    "usage": {      "orders": 0,      "waves": 0,      "api_calls": 0,      "accounts": 0    }  }}