Lister les limites de dépenses effectives

$ ant beta:organization:spend-limits:effective list

GET/v1/organizations/spend_limits/effective

Répertorie la limite de dépenses effective de chaque membre et ses dépenses depuis le début de la période.

Renvoie une ligne par couple (membre, période) pour lequel le membre résout une limite de dépenses, avec la portée source dont la limite de dépenses a été héritée. La pagination se fait par membre, de sorte que les périodes d'un membre ne sont jamais réparties sur plusieurs pages. Pris en charge uniquement pour les organisations Claude Enterprise, pas pour les organisations Claude Console.

Parameters

--limit: optional number⁠Query

Maximum number of members per page. A member's period rows never split across pages, so a page may carry more rows than this. Defaults to 20.

minimum1

maximum1000

--page: optional string⁠Query

Opaque cursor from a previous response's next_page field.

--period: optional array of "daily" or "monthly" or "weekly"⁠Query

Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.

maxItems3

--user-id: optional array of string⁠Query

Restrict the report to these members, by tagged user ID (user_...). At most 100 entries.

maxItems100

Returns

BetaListEffectiveSpendLimitsResponse: object{ data, next_page }

data: array of BetaSpendSummary { actor, amount, currency, 5 more }

actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor

One of the following:

beta_spend_limit_user_actor: object{ type: "user_actor", deleted, email_address, 2 more }

A user within the organization. name and email_address are null when the underlying account is unavailable or has been deleted; deleted is true only for deleted accounts.

type: "user_actor"

Actor type. Always user_actor.

deleted: boolean

True only when the underlying account has been deleted.

email_address: string

The user's email address. Null when the account is unavailable or has been deleted.

name: string

The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.

user_id: string

Tagged ID of the user.

beta_spend_limit_scoped_api_key_actor: object{ type: "scoped_api_key_actor", scoped_api_key_id }

A scoped Admin API key acting on behalf of the organization.

type: "scoped_api_key_actor"

scoped_api_key_id: string

amount: string

Effective limit amount as a non-negative integer decimal string in the minor unit of currency (cents for USD). null means no limit applies for this row's period — each period resolves independently, so another period may still cap this member.

currency: string

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

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

Period this row's effective limit and spend are reported for.

One of the following:

"daily"

"monthly"

"weekly"

period_to_date_spend: string

The member's spend so far in the current period, as a non-negative decimal string in the minor unit of currency (cents for USD). May carry fractional minor units up to three decimal places (e.g. "12050.5") — metered usage is not rounded to whole cents. Reads as "0" when the spend reading is temporarily unavailable.

scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more

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.

source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more

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" }

type: "usage_tier"

Scope type. Always usage_tier for this scope.

spend_limit_id: string

next_page: string

Lister les limites de dépenses effectives

ant beta:organization:spend-limits:effective list \
  --api-key my-anthropic-api-key

Response 200

{
  "data": [
    {
      "actor": {
        "deleted": true,
        "email_address": "email_address",
        "name": "name",
        "type": "user_actor",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "amount": "50000",
      "currency": "USD",
      "period": "daily",
      "period_to_date_spend": "12050.5",
      "scope": {
        "type": "user",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "source": {
        "type": "user",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "spend_limit_id": "spend_limit_id"
    }
  ],
  "next_page": "next_page"
}

Returns Examples

Response 200

{
  "data": [
    {
      "actor": {
        "deleted": true,
        "email_address": "email_address",
        "name": "name",
        "type": "user_actor",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "amount": "50000",
      "currency": "USD",
      "period": "daily",
      "period_to_date_spend": "12050.5",
      "scope": {
        "type": "user",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "source": {
        "type": "user",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "spend_limit_id": "spend_limit_id"
    }
  ],
  "next_page": "next_page"
}