One read of Claude Developer Platformapi-20261001T213726Z

api/beta/organization/spend_limits/set New page · 218 lines, new page

# Set Spend Limit ## Body parameters ## Returns ## Example ### Response (200)

A whole new page. There's nothing to diff it against, so here is what it says.

---
title: Set Spend Limit
url: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/set
---

# Set Spend Limit

**POST** `/v1/organizations/spend_limits`

Set a spend limit.

Upsert keyed on (scope, period): setting a limit that already exists
overwrites it in place. A Claude Enterprise organization sets `user`
limits. Its seat-tier, group, and organization-level defaults are configured
in claude.ai. A Claude Console organization sets `organization` and
`workspace` limits, which are monthly and always carry an amount. Setting those
limits is in an early access preview. To request access, contact your
Anthropic account team.

## Body parameters

- `amount: string or null`

  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.

  - `BetaSpendLimitUserScope object`

    Scope selecting a single member of the organization.

    - `type: "user"`

      Scope type. Always `user` for this scope.

      default: user

    - `user_id: string`

      Tagged ID of the member the spend limit applies to.

  - `BetaSpendLimitOrganizationScope object`

    - `type: "organization"`

      default: organization

  - `BetaSpendLimitWorkspaceScope object`

    Scope selecting one workspace of a Claude Console organization.

    - `type: "workspace"`

      Scope type. Always `workspace` for this scope.

      default: workspace

    - `workspace_id: string`

      Tagged ID of the workspace the spend limit applies to.

- `period: optional BetaSpendLimitPeriod`

  - `"daily"`

  - `"monthly"`

  - `"weekly"`

## Returns

- `BetaSpendLimit object`

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

  - `type: "spend_limit"`

    Object type. Always `spend_limit`.

    default: spend_limit

  - `id: string`

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

  - `amount: string or null`

    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.

    format: date-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) or for this member (`user` limit); `amount` is kept and applies again when it's switched back on. Always `true` for other limits.

  - `period: BetaSpendLimitPeriod`

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

    - `"daily"`

    - `"monthly"`

    - `"weekly"`

  - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`

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

    - `BetaSpendLimitUserScope object`

      Scope selecting a single member of the organization.

      - `type: "user"`

        Scope type. Always `user` for this scope.

        default: user

      - `user_id: string`

        Tagged ID of the member the spend limit applies to.

    - `BetaSpendLimitSeatTierScope object`

      - `type: "seat_tier"`

        default: seat_tier

      - `seat_tier: string`

    - `BetaSpendLimitRBACGroupScope object`

      - `type: "rbac_group"`

        default: rbac_group

      - `rbac_group_id: string`

    - `BetaSpendLimitOrganizationServiceScope object`

      - `type: "organization_service"`

        default: organization_service

      - `service: string`

    - `BetaSpendLimitOrganizationScope object`

      - `type: "organization"`

        default: organization

    - `BetaSpendLimitWorkspaceScope object`

      Scope selecting one workspace of a Claude Console organization.

      - `type: "workspace"`

        Scope type. Always `workspace` for this scope.

        default: workspace

      - `workspace_id: string`

        Tagged ID of the workspace the spend limit applies to.

  - `updated_at: string`

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

    format: date-time

## Example

```bash
curl https://api.anthropic.com/v1/organizations/spend_limits \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "amount": "50000",
          "scope": {
            "type": "user",
            "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
          },
          "period": "monthly"
        }'
```

### Response (200)

```json
{
  "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"
}
```

api/beta/organization/usage_report Changed · +10 / -8 lines

api/beta/organization/usage_report/retrieve_messages Changed · +7 / -5 lines

api/beta/organization/workspaces Changed · +12 / -0 lines

api/beta/organization/workspaces/service_accounts Changed · +10 / -0 lines

api/beta/sessions Changed · +110 / -0 lines

This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.

api/beta/sessions/archive Changed · +6 / -0 lines

api/beta/sessions/create Changed · +10 / -0 lines

api/beta/sessions/events Changed · +22 / -0 lines

This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.

api/beta/sessions/events/list Changed · +6 / -0 lines

api/beta/sessions/events/stream Changed · +6 / -0 lines

api/beta/sessions/list Changed · +6 / -0 lines

api/beta/sessions/resources Changed · +10 / -0 lines

api/beta/sessions/retrieve Changed · +6 / -0 lines

api/beta/sessions/threads Changed · +38 / -0 lines

This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.

api/beta/sessions/threads/archive Changed · +6 / -0 lines

api/beta/sessions/threads/events Changed · +12 / -0 lines

api/beta/sessions/threads/events/list Changed · +6 / -0 lines

api/beta/sessions/threads/events/stream Changed · +6 / -0 lines

api/beta/sessions/threads/list Changed · +6 / -0 lines

api/beta/sessions/threads/retrieve Changed · +6 / -0 lines

api/beta/sessions/update Changed · +6 / -0 lines

api/beta/skills Changed · +18 / -0 lines

api/beta/skills/versions Changed · +10 / -0 lines

api/beta/tunnels Changed · +20 / -0 lines