Skip to main content
POST
使用量設定を取得

概要

組織におけるユーザーごとの実効追加クレジット上限を取得します。上限は常にユーザー単位で適用されます。レスポンスには、リクエストしたスコープに直接設定された上限ではなく、より広いスコープの設定をマージしたうえで、リクエストした対象に実際に適用される上限が返されます。

リクエスト

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

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

boolean
true に設定すると、Teamレベルのユーザーごとの上限を取得します
string
グループ ID を与えると、特定のグループに適用される実効的なユーザーごとの上限を取得します。結果は、Teamレベルの上限にこのグループのオーバーライド (存在する場合) を統合したものです。ユーザーが所属している可能性のある他のグループや、ユーザーレベルのオーバーライドは考慮されません。
string
メールアドレスを与えると、特定のユーザーに適用される実効的なユーザーごとの上限を取得します。結果は、Teamレベルの上限、ユーザーが所属するすべてのグループのオーバーライド、およびユーザーレベルのオーバーライド (存在する場合) を統合したものです。
スコープを指定するには、team_level、group_id、user_email のいずれか1つを与える必要があります。

リクエスト例 - Team レベルのユーザーごとの上限を取得

リクエスト例 - グループのユーザーごとの実効上限を取得

リクエスト例 - ユーザーに適用されるユーザー単位上限の取得

レスポンス

integer
リクエストした対象に適用される実際の追加クレジット上限です。グループおよびユーザーのスコープでは、この値がより上位のスコープから継承されている場合があります。このフィールドがレスポンスに含まれていない場合、リクエストしたスコープにも、その継承元となるどのスコープにも上限は設定されていません。
このエンドポイントでは、返された上限がどのスコープで設定されたものかは分かりません。グループまたはユーザーをクエリした場合、リクエストしたスコープにオーバーライドが設定されていなくても、Team から (ユーザーの場合は、そのユーザーが所属するいずれかのグループから) 継承された上限が返されることがあります。

レスポンス例 - 上限が適用されている場合

レスポンス例 - 上限適用なし

エラーレスポンス

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