Skip to main content
POST
使用設定を構成する

概要

組織内のアドオンクレジットについて、ユーザーごとの利用上限を設定または解除できます。上限は常にユーザー単位で適用されます。チームまたはグループを対象に指定した場合でも、そのチームやグループ全体で共有の上限を設定するのではなく、そのチームまたはグループ内の各ユーザーに個別の上限が適用されます。

リクエスト

string
必須
“Billing Write” 権限を付与したサービスキー

クレジット上限の設定(いずれか一つを選択)

boolean
既存のアドオンのクレジット上限を消去するには true を設定します
integer
新しいアドオンのクレジット上限を設定します(整数値)
clear_add_on_credit_cap または set_add_on_credit_cap のいずれか一方のみを指定してください。両方を同時に指定することはできません。

スコープ設定(いずれかを選択)

boolean
チーム内のすべてのユーザーにユーザーごとの上限を適用するには true にします
string
特定のグループ内のすべてのユーザーにユーザーごとの上限を適用するには、グループ ID を指定します
string
特定のユーザーに適用する場合は、メールアドレスを指定します
スコープを定義するには、team_levelgroup_iduser_email のいずれかを必ず指定してください。

リクエスト例 - チーム内のすべてのユーザーにユーザー単位のクレジット上限を設定する

リクエスト例 - グループ内の全ユーザーのクレジット上限をユーザー単位で設定する

リクエスト例 - ユーザーのクレジット上限を設定する

リクエスト例 - クレジット上限のリセット

レスポンス

レスポンスボディは空です。200 ステータスコードは、この操作が正常に完了したことを示します。

エラー応答

一般的なエラーシナリオ:
  • 無効なサービスキーまたは権限不足
  • clear_add_on_credit_capset_add_on_credit_cap の両方が指定されている
  • clear_add_on_credit_capset_add_on_credit_cap も指定されていない
  • scope パラメーターが複数指定されている
  • scope パラメーターが指定されていない
  • 無効なグループ ID またはユーザーのメールアドレス
  • レート制限を超過