Saltar para a documentação
API

Ler o plano

O plano do espaço de trabalho, o que inclui e quanto dele já foi usado.

GET/billing

Executa a chamada real no seu espaço de trabalho.

GET /billing

O plano do espaço de trabalho, o que inclui e quanto dele já foi usado.

Exemplo

Requer billing:read. É o que Planos e faturação mostra: como o plano é faturado, quando se renova ou termina e a próxima cobrança, os domínios, os envios deste mês, as ações de IA de hoje e o pagamento por utilização. Um limit de null significa que o plano não tem nenhum.

curl
curl "$OE/billing" -H "$AUTH"
Resposta
{  "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 é false quando a faturação está desativada nesta instalação, e então nada tem limite.

Só o proprietário do espaço de trabalho chega à faturação: uma chave de API, ou um token de acesso que o proprietário ligou com todos os endereços. O token de um membro dá um 403 owner_only, e uma chave ou um token limitado a certos endereços ou domínios dá um 422 capability_unsupported.

Referência