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

プランを読む

ワークスペースのプラン、含まれる内容、使った量。

GET/billing

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

GET /billing

ワークスペースのプラン、含まれる内容、使った量。

例

billing:read が必要。プランと請求が表示する内容にあたる: プランの請求方法、更新日または終了日と次回の請求、ドメイン、今月の送信数、今日の AI アクション、従量課金。limit が null なら、プランに上限はない。

curl
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 は、このインストールで請求がオフのとき false になり、そのときは何にも上限がない。

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

リファレンス