メインコンテンツへスキップ
POST
使用量設定を指定

概要

組織向けのアドオン クレジットについて、ユーザーごとの使用量上限を設定または解除します。上限は常にユーザー単位で適用されます。チームまたはグループをスコープとして指定した場合、上限はそのチームまたはグループ内の各ユーザーに個別に適用され、チームまたはグループ全体で共有される上限は設定されません。

リクエスト

service_key
string
必須
「Billing Write」権限を持つサービスキー

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

clear_add_on_credit_cap
boolean
既存の追加クレジット上限をクリアするには、true を設定します
set_add_on_credit_cap
integer
新しい追加クレジット上限を設定します (整数値)
clear_add_on_credit_cap または set_add_on_credit_cap のいずれか一方を指定する必要があります。両方を指定することはできません。

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

team_level
boolean
チーム内のすべてのユーザーにユーザーごとの上限を適用するには、true に設定します
group_id
string
グループ ID を指定すると、特定のグループ内のすべてのユーザーにユーザーごとの上限が適用されます
user_email
string
メールアドレスを指定すると、特定のユーザーにこの設定が適用されます
スコープを定義するには、team_levelgroup_iduser_email のいずれか 1 つを指定する必要があります。

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

リクエスト例 - グループ内の全ユーザーに対してユーザーごとのクレジット上限を設定する

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

リクエスト例 - クレジット上限を解除

レスポンス

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

エラーレスポンス

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