ドキュメント本文へスキップ
API

請求の通知を一覧にする

アプリの請求バナーがいま表示する内容を、緊急度の高い順に。

GET/billing/alerts

実際の呼び出しをワークスペースに対して実行します。

GET /billing/alerts

アプリの請求バナーがいま表示する内容を、緊急度の高い順に。

例

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、upcoming_charge のいずれかで、target はプランと使用量のどちらに関するものかを示す。空の一覧は、伝えることがないことを意味する。

curl
curl "$OE/billing/alerts" -H "$AUTH"
レスポンス
{  "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    }  ]}

同じ状況が続く間、通知は同じ id を保つため、誰かが閉じた通知は閉じたままにできる。

請求に届くのはワークスペースのオーナーだけ: API キー、またはオーナーがすべてのアドレスで接続したアクセストークン。メンバーのトークンは 403 owner_only、特定のアドレスやドメインに限定したキーやトークンは 422 capability_unsupported になる。

リファレンス