Skip to main content
POST
Set Usage Configuration

Overview

Set or clear per-user usage caps on add-on credits for your organization. Caps are always applied on a per-user basis. When you specify a team or group scope, the cap is applied individually to each user within that team or group—it does not set a shared cap for the entire team or group.

Request

service_key
string
required
Your service key with “Billing Write” permissions

Credit Cap Configuration (Choose One)

clear_add_on_credit_cap
boolean
Set to true to clear the existing add-on credit cap
set_add_on_credit_cap
integer
Set a new add-on credit cap (integer value)
You must provide either clear_add_on_credit_cap or set_add_on_credit_cap, but not both.

Scope Configuration (Choose One)

team_level
boolean
Set to true to apply the per-user cap to every user on the team
group_id
string
Apply the per-user cap to every user in a specific group by providing the group ID
user_email
string
Apply the configuration to a specific user by providing their email address
You must provide one of team_level, group_id, or user_email to define the scope.

Example Request - Set Per-User Credit Cap for All Users on Team

Example Request - Set Per-User Credit Cap for All Users in a Group

Example Request - Set Credit Cap for User

Example Request - Clear Credit Cap

Response

The response body is empty. A 200 status code indicates the operation was successful.

Error Responses

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