Skip to main content
POST
Get Usage Configuration

Overview

Retrieve the effective per-user add-on credit cap for your organization. Caps are always per-user. The response returns the cap that is enforced for the requested subject after merging configuration from broader scopes, not only a cap configured directly at the requested scope.

Request

string
required
Your service key with “Billing Read” permissions

Scope Configuration (Choose One)

boolean
Set to true to retrieve the team-level per-user cap
string
Retrieve the effective per-user cap for a specific group by providing the group ID. The result merges the team-level cap with this group’s override, if any, and does not account for other groups a user may belong to or user-level overrides.
string
Retrieve the effective per-user cap for a specific user by providing their email address. The result merges the team-level cap, overrides from every group the user belongs to, and any user-level override.
You must provide one of team_level, group_id, or user_email to define the scope.

Example Request - Get Team-Level Per-User Cap

Example Request - Get Effective Per-User Cap for a Group

Example Request - Get Effective Per-User Cap for a User

Response

integer
The effective add-on credit cap for the requested subject. For group and user scopes, this value may be inherited from a broader scope. If this field is not present in the response, no cap applies at the requested scope or at any scope it inherits from.
This endpoint does not identify which scope supplied the returned cap. A group or user query can return a cap inherited from the team (or, for a user, from one of their groups) even when no override is configured at the requested scope.

Example Response - With Cap in Effect

Example Response - No Cap in Effect

Error Responses

Common error scenarios:
  • Invalid service key or insufficient permissions
  • Multiple scope parameters provided
  • No scope parameter provided
  • Invalid group ID or user email
  • Rate limit exceeded