アドオンを一覧する
プランに追加で購入できるもの。現在は送信用の専用IP。
3件の呼び出しをワークスペースに対して実行します。
GET /billing/add-ons
プランに追加で購入できるもの。現在は送信用の専用IP。
例
billing:read が必要。eligibility は、ワークスペースが専用IPの条件を満たすかどうかを示す。Business または Enterprise プランと、1か月に 100,000 通以上の送信が必要である。その量に満たないと、専用IPは共有IPより到達率が下がるためだ。reason は足りないものを plan または volume で示す。
curl "$OE/billing/add-ons" -H "$AUTH"{ "object": "list", "data": [{ "object": "add_on", "addOn": "dedicated-ip", "available": true, "status": null, "priceCents": 3999, "endsAt": null, "eligibility": { "eligible": false, "plan": "business", "monthlySends": 41200, "minimumMonthlySends": 100000, "reason": "volume" }, "ips": []}] }status は、ワークスペースがアドオンを持つまでは null で、その後は設定中の pending、warming、active、そして取り外し中の releasing になる。
請求に届くのはワークスペースのオーナーだけ: API キー、またはオーナーがすべてのアドレスで接続したアクセストークン。メンバーのトークンは 403 owner_only、特定のアドレスやドメインに限定したキーやトークンは 422 capability_unsupported になる。
購入する
billing:write が必要。POST /billing/add-ons/checkout は、本人が支払うためのリンクを返す。支払いが済むと、IPが設定され、ウォームアップされる。
curl -X POST "$OE/billing/add-ons/checkout" -H "$AUTH" -H 'content-type: application/json' \ -d '{ "addOn": "dedicated-ip" }'{ "object": "add_on_checkout", "addOn": "dedicated-ip", "url": "https://checkout.example.com/c/9Tn4wRb1xK7pQ2zd" }すでに持っているワークスペースは 409 add_on_already_active、条件を満たさないワークスペースは 409 add_on_not_eligible、すべてのIPが使用中の場合は 409 add_on_sold_out になる。
API を通じて支払うことはない。リンクは決済プロバイダーのページを開き、本人はアプリから行うのと同じように、そこで支払い、カードの変更、解約を行う。
OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。
解約する
billing:write が必要。DELETE /billing/add-ons/dedicated-ip は、支払い済みの月の終わりに解約する。その日付は endsAt でわかる。その後IPは解放され、メールは再び共有IPから送信される。
curl -X DELETE "$OE/billing/add-ons/dedicated-ip" -H "$AUTH"{ "object": "add_on", "addOn": "dedicated-ip", "status": "active", "endsAt": "2026-11-01T00:00:00.000Z" }アドオンを持たないワークスペースは 409 add_on_not_active になる。
OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。