Claude Platform Docs

Definir limite de gastos

$ ant beta:organization:spend-limits set
POST/v1/organizations/spend_limits

Define um limite de gastos.

Upsert com chave em (escopo, período): definir um limite que já existe o sobrescreve no lugar. Uma organização Claude Enterprise define limites de user. Seus padrões por nível de assento, por grupo e no nível da organização são configurados no claude.ai. Uma organização do Claude Console define limites de organization e workspace, que são mensais e sempre têm um valor. A definição desses limites está em uma prévia de acesso antecipado. Para solicitar acesso, entre em contato com sua equipe de conta da Anthropic.

Parameters
--amount: string

Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): "50000" is $500.00. null sets an explicit no-limit override for this scope and period only — each period resolves independently, so caps for other periods still apply.

--scope: BetaSpendLimitUserScope or BetaSpendLimitOrganizationScope or BetaSpendLimitWorkspaceScope

What the limit applies to. Claude Enterprise organizations set user limits. Claude Console organizations set organization and workspace limits. Any other combination returns 400. Setting organization and workspace limits through the API is in an early access preview. To request access, contact your Anthropic account team.

--period: optional "daily" or "monthly" or "weekly"
--beta: optional array of AnthropicBeta⁠Header parameter

Optional header to specify the beta version(s) you want to use.

Returns
beta_spend_limit: object{ type: "spend_limit", id, amount, 6 more }

A configured spend limit: a cap on metered spend for one scope and period.

type: "spend_limit"

Object type. Always spend_limit.

id: string

Unique tagged ID of the spend limit (spl_...).

amount: string

Limit amount as a non-negative integer decimal string in the minor unit of currency (cents for USD): "50000" is $500.00. null means no numeric cap is configured at this scope — see the effective report for whether a limit applies.

created_at: string

RFC 3339 datetime at which the spend limit was created.

formatdate-time
currency: string

ISO 4217 code of the organization's billing currency; the unit for amount.

is_enabled: boolean

Read-only. false when extra usage is switched off for this organization (organization limit); amount is kept and applies again when it's switched back on. Always true for other limits.

period: "daily" or "monthly" or "weekly"

Length of the window the limit resets over. amount caps spend within each period.

One of the following:
"daily"
"monthly"
"weekly"
scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more

What the limit applies to. A tagged union on type; each variant carries the identifier for its scope.

One of the following:
beta_spend_limit_user_scope: object{ type: "user", user_id }

Scope selecting a single member of the organization.

type: "user"

Scope type. Always user for this scope.

user_id: string

Tagged ID of the member the spend limit applies to.

beta_spend_limit_seat_tier_scope: object{ type: "seat_tier", seat_tier }
type: "seat_tier"
seat_tier: string
beta_spend_limit_rbac_group_scope: object{ type: "rbac_group", rbac_group_id }
type: "rbac_group"
rbac_group_id: string
beta_spend_limit_organization_service_scope: object{ type: "organization_service", service }
type: "organization_service"
service: string
beta_spend_limit_organization_scope: object{ type: "organization" }
type: "organization"
beta_spend_limit_workspace_scope: object{ type: "workspace", workspace_id }

Scope selecting one workspace of a Claude Console organization.

type: "workspace"

Scope type. Always workspace for this scope.

workspace_id: string

Tagged ID of the workspace the spend limit applies to.

beta_spend_limit_usage_tier_scope: object{ type: "usage_tier" }

Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its created_at and updated_at are the organization's creation time, so amount can change while updated_at stays the same.

type: "usage_tier"

Scope type. Always usage_tier for this scope.

updated_at: string

RFC 3339 datetime at which the spend limit was last modified.

formatdate-time
Definir limite de gastos
ant beta:organization:spend-limits set \
  --api-key my-anthropic-api-key \
  --amount 50000 \
  --scope '{type: user, user_id: user_01WCz1FkmYMm4gnmykNKUu3Q}'
Returns Examples
Response 200
{
  "id": "id",
  "amount": "50000",
  "created_at": "2019-12-27T18:11:19.117Z",
  "currency": "USD",
  "is_enabled": true,
  "period": "daily",
  "scope": {
    "type": "user",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "type": "spend_limit",
  "updated_at": "2019-12-27T18:11:19.117Z"
}