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

従量課金をオンまたはオフにする

プランと請求のスイッチと、初回に必要なカード。

PATCH/billing/pay-as-you-go

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

PATCH /billing/pay-as-you-go

プランと請求のスイッチと、初回に必要なカード。

例

billing:write が必要。オフはすぐに反映され、使用量は枠で止まる。オンはカードが保存されていればすぐに反映される。初回は checkoutUrl が本人がカードを追加するリンクで、追加すると従量課金が始まる。theme と locale でリンク先ページの見た目を決める。

curl
curl -X PATCH "$OE/billing/pay-as-you-go" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "enabled": true, "locale": "de" }'
レスポンス
{  "object": "pay_as_you_go_switch",  "enabled": false,  "suspended": false,  "activating": false,  "checkoutUrl": "https://checkout.example.com/c/7Yw2kq9RzX4mB1vN?locale=de"}

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

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

チェックアウトの後

billing:write が必要。本人がカードを追加した後、POST /billing/pay-as-you-go/confirm が決済プロバイダーに確認して記録する。本人が戻ったときにアプリが行うのと同じ処理である。enabled は従量課金がいまオンかどうかを示し、もう一度呼んでも問題ない。

curl
curl -X POST "$OE/billing/pay-as-you-go/confirm" -H "$AUTH"
レスポンス
{ "object": "pay_as_you_go_confirmation", "enabled": true }

スイッチからの activating: true は、カードが保存されたばかりで従量課金をオンにしている途中であることを意味する。少ししてからもう一度読むこと。

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

リファレンス