API
Read the plan
The plan of the workspace, what it includes and how much of it is used.
GET/billing
Runs the real call on your workspace.
GET /billing
The plan of the workspace, what it includes and how much of it is used.
Example
Needs billing:read. It is what Plans & Billing shows: how the plan is billed, when it renews or ends and the next charge, the domains, this month’s sends, today’s AI actions and pay as you go. A limit of null means the plan has none.
curl "$OE/billing" -H "$AUTH"{ "object": "billing", "workspaceId": "3d0f6c2e-8a41-4b57-9e2a-61c4f0b8d7a5", "workspaceName": "Acme", "plan": "business", "planName": "Business", "metered": true, "interval": "month", "renewsAt": "2026-11-01T09:00:00.000Z", "cancelAtPeriodEnd": false, "nextCharge": { "cents": 10000, "currency": "usd", "at": "2026-11-01T09:00:00.000Z" }, "domains": { "used": 3, "included": 500, "canAdd": true }, "usage": { "sends": { "used": 18240, "limit": 200000, "resetsAt": "2026-11-01T00:00:00.000Z" }, "aiActions": { "used": 12, "limit": 150, "resetsAt": "2026-10-04T00:00:00.000Z" } }, "payAsYouGo": { "available": true, "enabled": true, "suspended": false, "enrolled": true, "switchedOn": true, "coversSends": true, "coversAiActions": true, "limitCents": 5000, "spentCents": 120, "extraSends": 3000, "extraAiActions": 0, "estimatedCents": 120 }, "availablePlans": ["free", "starter", "business", "enterprise"]}metered is false when billing is off on this install, and then nothing is capped.
Only the owner of the workspace reaches billing: an API key, or an access token the owner connected with every address. A member’s token is a 403 owner_only, and a key or token limited to particular addresses or domains is a 422 capability_unsupported.