Skip to main content
POST
利用設定の取得

概要

組織の現在のユーザー単位のアドオンのクレジット上限設定を取得します。上限は常にユーザー単位です。チームまたはグループのスコープでクエリを実行すると、レスポンスには、そのチームまたはグループ内のユーザーに適用されているユーザー単位の上限が返されます。

リクエスト

string
必須
“Billing Read” 権限を持つサービスキー

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

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

チーム内の全ユーザーのユーザー別上限を取得するリクエスト例

グループ内全ユーザーのユーザー別上限を取得するリクエスト例

リクエスト例 - ユーザー設定の取得

レスポンス

integer
設定されているアドオンのクレジットの上限値。このフィールドがレスポンスに含まれていない場合、指定されたスコープレベルには上限が設定されていません。

レスポンス例 - Cap を設定した場合

レスポンス例 - 上限が設定されていない場合

エラー応答

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