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

チェックアウトを開始する

有料プランを購入するリンク。

POST/billing/checkout

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

POST /billing/checkout

有料プランを購入するリンク。

例

billing:write が必要。plan は starter、business、enterprise のいずれかで、interval は既定の month または year。本人がそこで支払うまでは何も請求されず、支払うとプランが始まる。

curl
curl -X POST "$OE/billing/checkout" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "plan": "business", "interval": "year" }'
レスポンス
{ "object": "checkout", "url": "https://checkout.example.com/c/3Hq8vXnP2sT6kL0w" }

すでにプランの料金を払っているワークスペースは 409 plan_conflict になる。代わりに請求ポータルでプランを変更すること。このインストールで販売していないプランや期間は 422 plan_unavailable になる。

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

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

リファレンス