Saltar para a documentação
API

Listar os alertas de faturação

O que o aviso de faturação da app diria agora, o mais urgente primeiro.

GET/billing/alerts

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

GET /billing/alerts

O que o aviso de faturação da app diria agora, o mais urgente primeiro.

Exemplo

Requer billing:read. kind é payment_failed, pay_as_you_go_paused, sending_paused, spend_limit_reached, ai_used_up, plan_ending, sends_nearly_used, spend_nearly_reached ou upcoming_charge, e target diz se é sobre o plano ou sobre a utilização. Uma lista vazia significa que não há nada a dizer.

curl
curl "$OE/billing/alerts" -H "$AUTH"
Resposta
{  "object": "list",  "data": [    {      "object": "billing_alert",      "id": "upcoming_charge:plan:2026-11-01T09:00:00.000Z",      "kind": "upcoming_charge",      "severity": "info",      "target": "billing",      "planName": "Business",      "at": "2026-11-01T09:00:00.000Z",      "cents": 10000,      "currency": "usd",      "used": null,      "limit": null,      "payAsYouGo": false    }  ]}

Um alerta mantém o seu id enquanto a mesma coisa for verdade, por isso um alerta que alguém dispensou pode continuar dispensado.

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