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

請求ポータルを開く

プランを変更または解約するリンク。

POST/billing/portal

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

POST /billing/portal

プランを変更または解約するリンク。

例

billing:write が必要。プランと請求の「管理」にあたる: ポータルで本人がプランを変更または解約し、カードを更新し、過去の請求書をダウンロードする。本文は省略でき、theme と locale でページの見た目を決める。

curl
curl -X POST "$OE/billing/portal" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "theme": "dark" }'
レスポンス
{ "object": "billing_portal", "url": "https://billing.example.com/portal/s/Qm4vT8" }

API を通じて支払うことはない。リンクは決済プロバイダーのページを開き、本人はアプリから行うのと同じように、そこで支払い、カードの変更、解約を行う。

OAuth アクセストークンでこの呼び出しを行うには確認コードが必要です。アプリが直近 60 分以内にコードを確認するまで、呼び出しは 403 step_up_required を返し、何も変更しません。API キーが求められることはありません。コードの求め方と確認方法は「認証」ページにあります。

リファレンス