--- title: Spend Limits url: https://platform.claude.com/docs/en/api/java/beta/organization/spend_limits --- # Spend Limits ## Set Spend Limit `BetaSpendLimit beta().organization().spendLimits().set(params, requestOptions = RequestOptions.none())` **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. ### Parameters - `SpendLimitSetParams params` - `Optional> betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` - `Optional amount` 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 scope` 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. - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `Optional period` ### Returns - `class BetaSpendLimit` A configured spend limit: a cap on metered spend for one scope and period. - `JsonValue type = "spend_limit"` Object type. Always `spend_limit`. - `String id` Unique tagged ID of the spend limit (`spl_...`). - `Optional amount` 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. - `LocalDateTime createdAt` RFC 3339 datetime at which the spend limit was created. format: date-time - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `boolean isEnabled` 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. - `BetaSpendLimitPeriod period` Length of the window the limit resets over. `amount` caps spend within each period. - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Scope scope` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `LocalDateTime updatedAt` RFC 3339 datetime at which the spend limit was last modified. format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.BetaSpendLimit; import com.anthropic.models.beta.organization.spendlimits.SpendLimitSetParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); SpendLimitSetParams params = SpendLimitSetParams.builder() .amount("50000") .userScope("user_01WCz1FkmYMm4gnmykNKUu3Q") .build(); BetaSpendLimit betaSpendLimit = client.beta().organization().spendLimits().set(params); } } ``` #### 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" } ``` ## Get Spend Limit `BetaSpendLimit beta().organization().spendLimits().retrieve(params = SpendLimitRetrieveParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/spend_limits/{spend_limit_id}` Retrieve a spend limit by ID. ### Parameters - `SpendLimitRetrieveParams params` - `Optional spendLimitId` (path parameter) ID of the Spend Limit. ### Returns - `class BetaSpendLimit` A configured spend limit: a cap on metered spend for one scope and period. - `JsonValue type = "spend_limit"` Object type. Always `spend_limit`. - `String id` Unique tagged ID of the spend limit (`spl_...`). - `Optional amount` 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. - `LocalDateTime createdAt` RFC 3339 datetime at which the spend limit was created. format: date-time - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `boolean isEnabled` 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. - `BetaSpendLimitPeriod period` Length of the window the limit resets over. `amount` caps spend within each period. - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Scope scope` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `LocalDateTime updatedAt` RFC 3339 datetime at which the spend limit was last modified. format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.BetaSpendLimit; import com.anthropic.models.beta.organization.spendlimits.SpendLimitRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaSpendLimit betaSpendLimit = client.beta().organization().spendLimits().retrieve("spend_limit_id"); } } ``` #### 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" } ``` ## Delete Spend Limit `SpendLimitDeleteResponse beta().organization().spendLimits().delete(params = SpendLimitDeleteParams.none(), requestOptions = RequestOptions.none())` **DELETE** `/v1/organizations/spend_limits/{spend_limit_id}` Delete a spend limit. For a Claude Enterprise organization, this deletes a per-user override, and the member falls back to any inherited spend limit at that period. Its seat-tier, group, and organization-level rows cannot be deleted via this endpoint. A Claude Console organization deletes its organization and workspace limits, but not its `usage_tier` limit. Deleting organization and workspace limits through the API is in an early access preview. ### Parameters - `SpendLimitDeleteParams params` - `Optional spendLimitId` (path parameter) ID of the Spend Limit. ### Returns - `class SpendLimitDeleteResponse` - `JsonValue type = "spend_limit_deleted"` - `String id` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.SpendLimitDeleteParams; import com.anthropic.models.beta.organization.spendlimits.SpendLimitDeleteResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); SpendLimitDeleteResponse spendLimit = client.beta().organization().spendLimits().delete("spend_limit_id"); } } ``` #### Response (200) ```json { "id": "id", "type": "spend_limit_deleted" } ``` ## List Spend Limits `SpendLimitListPage beta().organization().spendLimits().list(params = SpendLimitListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/spend_limits` List the organization's spend limits. Limits are grouped by scope type, in the order `organization`, `seat_tier`, `rbac_group`, `organization_service`, `user`; within a type they come in a fixed order that is not creation order. Supported for Claude Enterprise organizations only, not for Claude Console organizations. ### Parameters - `SpendLimitListParams params` - `Optional limit` (query parameter) Maximum number of limits per page. Defaults to `20`. minimum: 1, maximum: 1000 - `Optional page` (query parameter) Opaque cursor from a previous response's `next_page` field. - `Optional> scopeType` (query parameter) Return only limits with these scope types. Omit for all. maxItems: 100 - `ORGANIZATION("organization")` - `ORGANIZATION_SERVICE("organization_service")` - `RBAC_GROUP("rbac_group")` - `SEAT_TIER("seat_tier")` - `USER("user")` - `WORKSPACE("workspace")` - `Optional> betas` (header parameter) This endpoint is in beta: requests must send `spend-limit-reads-2026-09-26` in this header. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `USER_PROFILES_2026_08_18("user-profiles-2026-08-18")` - `USER_PROFILES_2026_09_04("user-profiles-2026-09-04")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `DREAMING_2026_04_21("dreaming-2026-04-21")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `SERVER_SIDE_FALLBACK_2026_06_01("server-side-fallback-2026-06-01")` - `SERVER_SIDE_FALLBACK_2026_07_01("server-side-fallback-2026-07-01")` - `FALLBACK_CREDIT_2026_06_01("fallback-credit-2026-06-01")` - `FALLBACK_CREDIT_2026_07_01("fallback-credit-2026-07-01")` - `AGENT_MEMORY_2026_07_22("agent-memory-2026-07-22")` - `MID_CONVERSATION_TOOL_CHANGES_2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `COMPACT_2026_01_12("compact-2026-01-12")` - `COMPUTER_USE_2025_11_24("computer-use-2025-11-24")` - `MCP_TUNNELS_2026_06_22("mcp-tunnels-2026-06-22")` - `STRUCTURED_OUTPUTS_2025_11_13("structured-outputs-2025-11-13")` - `TASK_BUDGETS_2026_03_13("task-budgets-2026-03-13")` - `THINKING_DISPLAY_UPDATES_2026_08_18("thinking-display-updates-2026-08-18")` - `CE_USER_MANAGEMENT_2026_07_13("ce-user-management-2026-07-13")` - `MID_CONVERSATION_OUTPUT_CONFIG_2026_07_01("mid-conversation-output-config-2026-07-01")` - `THINKING_BINDING_CONTROLS_2026_08_01("thinking-binding-controls-2026-08-01")` - `MID_CONVERSATION_SYSTEM_CLEAR_AT_2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `COMPACT_2026_09_04("compact-2026-09-04")` - `INLINE_TOOLS_2026_09_15("inline-tools-2026-09-15")` - `MCP_CLIENT_2026_09_15("mcp-client-2026-09-15")` - `CE_PLUGINS_2026_09_01("ce-plugins-2026-09-01")` - `SPEND_LIMIT_READS_2026_09_26("spend-limit-reads-2026-09-26")` - `TELEMETRY_DESTINATIONS_2026_08_11("telemetry-destinations-2026-08-11")` ### Returns - `class BetaSpendLimit` A configured spend limit: a cap on metered spend for one scope and period. - `JsonValue type = "spend_limit"` Object type. Always `spend_limit`. - `String id` Unique tagged ID of the spend limit (`spl_...`). - `Optional amount` 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. - `LocalDateTime createdAt` RFC 3339 datetime at which the spend limit was created. format: date-time - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `boolean isEnabled` 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. - `BetaSpendLimitPeriod period` Length of the window the limit resets over. `amount` caps spend within each period. - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Scope scope` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `LocalDateTime updatedAt` RFC 3339 datetime at which the spend limit was last modified. format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.SpendLimitListPage; import com.anthropic.models.beta.organization.spendlimits.SpendLimitListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); SpendLimitListPage page = client.beta().organization().spendLimits().list(); } } ``` #### Response (200) ```json { "data": [ { "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" } ], "next_page": "next_page" } ``` ## Domain types ### Beta Spend Limit - `class BetaSpendLimit` A configured spend limit: a cap on metered spend for one scope and period. - `JsonValue type = "spend_limit"` Object type. Always `spend_limit`. - `String id` Unique tagged ID of the spend limit (`spl_...`). - `Optional amount` 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. - `LocalDateTime createdAt` RFC 3339 datetime at which the spend limit was created. format: date-time - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `boolean isEnabled` 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. - `BetaSpendLimitPeriod period` Length of the window the limit resets over. `amount` caps spend within each period. - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Scope scope` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `LocalDateTime updatedAt` RFC 3339 datetime at which the spend limit was last modified. format: date-time ### Beta Spend Limit Organization Scope - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` ### Beta Spend Limit Organization Service Scope - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` ### Beta Spend Limit Period - `enum BetaSpendLimitPeriod` - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` ### Beta Spend Limit RBAC Group Scope - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` ### Beta Spend Limit Scoped API Key Actor - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `JsonValue type = "scoped_api_key_actor"` - `String scopedApiKeyId` ### Beta Spend Limit Seat Tier Scope - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` ### Beta Spend Limit Usage Tier Scope - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. ### Beta Spend Limit User Actor - `class BetaSpendLimitUserActor` 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. - `JsonValue type = "user_actor"` Actor type. Always `user_actor`. - `boolean deleted` True only when the underlying account has been deleted. - `Optional emailAddress` The user's email address. Null when the account is unavailable or has been deleted. - `Optional name` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `String userId` Tagged ID of the user. ### Beta Spend Limit User Scope - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. ### Beta Spend Limit Workspace Scope - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. ### Beta Spend Summary - `class BetaSpendSummary` Per-member effective-limit report row (`GET /spend_limits/effective`). - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `JsonValue type = "user_actor"` Actor type. Always `user_actor`. - `boolean deleted` True only when the underlying account has been deleted. - `Optional emailAddress` The user's email address. Null when the account is unavailable or has been deleted. - `Optional name` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `String userId` Tagged ID of the user. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `JsonValue type = "scoped_api_key_actor"` - `String scopedApiKeyId` - `Optional amount` 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. - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `BetaSpendLimitPeriod period` Period this row's effective limit and spend are reported for. - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `String periodToDateSpend` 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 scope` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `Source source` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `class BetaSpendLimitSeatTierScope` - `class BetaSpendLimitRbacGroupScope` - `class BetaSpendLimitOrganizationServiceScope` - `class BetaSpendLimitOrganizationScope` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `class BetaSpendLimitUsageTierScope` 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. - `String spendLimitId` ## Spend Limits › Effective ### List Effective Spend Limits `EffectiveListPage beta().organization().spendLimits().effective().list(params = EffectiveListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/spend_limits/effective` List each member's effective spend limit and period-to-date spend. Returns one row per (member, period) the member resolves a spend limit for, with the `source` scope the spend limit was inherited from. Paginates by member, so a member's periods never split across pages. Supported for Claude Enterprise organizations only, not for Claude Console organizations. #### Parameters - `EffectiveListParams params` - `Optional limit` (query parameter) 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`. minimum: 1, maximum: 1000 - `Optional page` (query parameter) Opaque cursor from a previous response's `next_page` field. - `Optional> period` (query parameter) Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for. maxItems: 3 - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Optional> userIds` (query parameter) Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries. maxItems: 100 #### Returns - `class BetaSpendSummary` Per-member effective-limit report row (`GET /spend_limits/effective`). - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `JsonValue type = "user_actor"` Actor type. Always `user_actor`. - `boolean deleted` True only when the underlying account has been deleted. - `Optional emailAddress` The user's email address. Null when the account is unavailable or has been deleted. - `Optional name` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `String userId` Tagged ID of the user. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `JsonValue type = "scoped_api_key_actor"` - `String scopedApiKeyId` - `Optional amount` 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. - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `BetaSpendLimitPeriod period` Period this row's effective limit and spend are reported for. - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `String periodToDateSpend` 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 scope` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `Source source` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `class BetaSpendLimitSeatTierScope` - `class BetaSpendLimitRbacGroupScope` - `class BetaSpendLimitOrganizationServiceScope` - `class BetaSpendLimitOrganizationScope` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `class BetaSpendLimitUsageTierScope` 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. - `String spendLimitId` #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.effective.EffectiveListPage; import com.anthropic.models.beta.organization.spendlimits.effective.EffectiveListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); EffectiveListPage page = client.beta().organization().spendLimits().effective().list(); } } ``` ##### Response (200) ```json { "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" } ``` ## Spend Limits › Increase Requests ### List Spend Limit Increase Requests `IncreaseRequestListPage beta().organization().spendLimits().increaseRequests().list(params = IncreaseRequestListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/spend_limit_increase_requests` List spend limit increase requests, most recent first. Pending requests include a live `spend_summary` for the requester. Requests whose requester is no longer a member are excluded. #### Parameters - `IncreaseRequestListParams params` - `Optional> actorIds` (query parameter) Filter by requester, as `user_...` tagged IDs. - `Optional limit` (query parameter) minimum: 1, maximum: 1000 - `Optional page` (query parameter) Opaque cursor from a previous response's `next_page`. - `Optional> status` (query parameter) Filter by status. Omit to return all. - `APPROVED("approved")` - `DENIED("denied")` - `PENDING("pending")` #### Returns - `class BetaSpendLimitIncreaseRequest` - `JsonValue type = "spend_limit_increase_request"` - `String id` - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `JsonValue type = "user_actor"` Actor type. Always `user_actor`. - `boolean deleted` True only when the underlying account has been deleted. - `Optional emailAddress` The user's email address. Null when the account is unavailable or has been deleted. - `Optional name` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `String userId` Tagged ID of the user. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `JsonValue type = "scoped_api_key_actor"` - `String scopedApiKeyId` - `LocalDateTime createdAt` format: date-time - `BetaSpendLimitPeriod period` - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Optional resolvedAt` format: date-time - `Optional resolvedBy` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `Optional spendSummary` Per-member effective-limit report row (`GET /spend_limits/effective`). - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `Optional amount` 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. - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `BetaSpendLimitPeriod period` Period this row's effective limit and spend are reported for. - `String periodToDateSpend` 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 scope` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `Source source` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `class BetaSpendLimitSeatTierScope` - `class BetaSpendLimitRbacGroupScope` - `class BetaSpendLimitOrganizationServiceScope` - `class BetaSpendLimitOrganizationScope` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `class BetaSpendLimitUsageTierScope` 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. - `String spendLimitId` - `BetaSpendLimitIncreaseRequestStatus status` - `APPROVED("approved")` - `DENIED("denied")` - `PENDING("pending")` #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.increaserequests.IncreaseRequestListPage; import com.anthropic.models.beta.organization.spendlimits.increaserequests.IncreaseRequestListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); IncreaseRequestListPage page = client.beta().organization().spendLimits().increaseRequests().list(); } } ``` ##### Response (200) ```json { "data": [ { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "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" }, "status": "approved", "type": "spend_limit_increase_request" } ], "next_page": "next_page" } ``` ### Get Spend Limit Increase Request `BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().retrieve(params = IncreaseRequestRetrieveParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}` Retrieve a spend limit increase request. While `pending`, the response includes a live `spend_summary` for the requester at the request's period. #### Parameters - `IncreaseRequestRetrieveParams params` - `Optional spendLimitIncreaseRequestId` (path parameter) ID of the spend limit increase request. #### Returns - `class BetaSpendLimitIncreaseRequest` - `JsonValue type = "spend_limit_increase_request"` - `String id` - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `JsonValue type = "user_actor"` Actor type. Always `user_actor`. - `boolean deleted` True only when the underlying account has been deleted. - `Optional emailAddress` The user's email address. Null when the account is unavailable or has been deleted. - `Optional name` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `String userId` Tagged ID of the user. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `JsonValue type = "scoped_api_key_actor"` - `String scopedApiKeyId` - `LocalDateTime createdAt` format: date-time - `BetaSpendLimitPeriod period` - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Optional resolvedAt` format: date-time - `Optional resolvedBy` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `Optional spendSummary` Per-member effective-limit report row (`GET /spend_limits/effective`). - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `Optional amount` 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. - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `BetaSpendLimitPeriod period` Period this row's effective limit and spend are reported for. - `String periodToDateSpend` 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 scope` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `Source source` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `class BetaSpendLimitSeatTierScope` - `class BetaSpendLimitRbacGroupScope` - `class BetaSpendLimitOrganizationServiceScope` - `class BetaSpendLimitOrganizationScope` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `class BetaSpendLimitUsageTierScope` 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. - `String spendLimitId` - `BetaSpendLimitIncreaseRequestStatus status` - `APPROVED("approved")` - `DENIED("denied")` - `PENDING("pending")` #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.increaserequests.BetaSpendLimitIncreaseRequest; import com.anthropic.models.beta.organization.spendlimits.increaserequests.IncreaseRequestRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaSpendLimitIncreaseRequest betaSpendLimitIncreaseRequest = client.beta().organization().spendLimits().increaseRequests().retrieve("spend_limit_increase_request_id"); } } ``` ##### Response (200) ```json { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "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" }, "status": "approved", "type": "spend_limit_increase_request" } ``` ### Approve Spend Limit Increase Request `IncreaseRequestApproveResponse beta().organization().spendLimits().increaseRequests().approve(params, requestOptions = RequestOptions.none())` **POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve` Approve a pending spend limit increase request. Writes a per-user spend limit at `amount` for the requester and transitions the request to `approved`. `period` defaults to the period the member was blocked on. Anthropic emails the requester unless `suppress_notification` is set. #### Parameters - `IncreaseRequestApproveParams params` - `Optional spendLimitIncreaseRequestId` (path parameter) ID of the spend limit increase request. - `String amount` New per-user spend limit as a non-negative integer decimal string (minor units). - `Optional period` - `Optional suppressNotification` #### Returns - `class IncreaseRequestApproveResponse` - `JsonValue type = "spend_limit_increase_request"` - `String id` - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `JsonValue type = "user_actor"` Actor type. Always `user_actor`. - `boolean deleted` True only when the underlying account has been deleted. - `Optional emailAddress` The user's email address. Null when the account is unavailable or has been deleted. - `Optional name` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `String userId` Tagged ID of the user. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `JsonValue type = "scoped_api_key_actor"` - `String scopedApiKeyId` - `LocalDateTime createdAt` format: date-time - `BetaSpendLimitPeriod period` - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Optional resolvedAt` format: date-time - `Optional resolvedBy` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `BetaSpendLimit spendLimit` A configured spend limit: a cap on metered spend for one scope and period. - `JsonValue type = "spend_limit"` Object type. Always `spend_limit`. - `String id` Unique tagged ID of the spend limit (`spl_...`). - `Optional amount` 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. - `LocalDateTime createdAt` RFC 3339 datetime at which the spend limit was created. format: date-time - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `boolean isEnabled` 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. - `BetaSpendLimitPeriod period` Length of the window the limit resets over. `amount` caps spend within each period. - `Scope scope` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `LocalDateTime updatedAt` RFC 3339 datetime at which the spend limit was last modified. format: date-time - `Optional spendSummary` Per-member effective-limit report row (`GET /spend_limits/effective`). - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `Optional amount` 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. - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `BetaSpendLimitPeriod period` Period this row's effective limit and spend are reported for. - `String periodToDateSpend` 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 scope` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `class BetaSpendLimitSeatTierScope` - `class BetaSpendLimitRbacGroupScope` - `class BetaSpendLimitOrganizationServiceScope` - `class BetaSpendLimitOrganizationScope` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `class BetaSpendLimitUsageTierScope` 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. - `Source source` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `class BetaSpendLimitSeatTierScope` - `class BetaSpendLimitRbacGroupScope` - `class BetaSpendLimitOrganizationServiceScope` - `class BetaSpendLimitOrganizationScope` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `class BetaSpendLimitUsageTierScope` 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. - `String spendLimitId` - `BetaSpendLimitIncreaseRequestStatus status` - `APPROVED("approved")` - `DENIED("denied")` - `PENDING("pending")` #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.increaserequests.IncreaseRequestApproveParams; import com.anthropic.models.beta.organization.spendlimits.increaserequests.IncreaseRequestApproveResponse; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); IncreaseRequestApproveParams params = IncreaseRequestApproveParams.builder() .spendLimitIncreaseRequestId("spend_limit_increase_request_id") .amount("50000") .build(); IncreaseRequestApproveResponse response = client.beta().organization().spendLimits().increaseRequests().approve(params); } } ``` ##### Response (200) ```json { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit": { "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" }, "spend_summary": { "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" }, "status": "approved", "type": "spend_limit_increase_request" } ``` ### Deny Spend Limit Increase Request `BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().deny(params = IncreaseRequestDenyParams.none(), requestOptions = RequestOptions.none())` **POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny` Deny a pending spend limit increase request. Idempotent on `denied`; denying an already-`approved` request returns 400. Anthropic emails the requester unless `suppress_notification` is set. #### Parameters - `IncreaseRequestDenyParams params` - `Optional spendLimitIncreaseRequestId` (path parameter) ID of the spend limit increase request. - `Optional suppressNotification` #### Returns - `class BetaSpendLimitIncreaseRequest` - `JsonValue type = "spend_limit_increase_request"` - `String id` - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `JsonValue type = "user_actor"` Actor type. Always `user_actor`. - `boolean deleted` True only when the underlying account has been deleted. - `Optional emailAddress` The user's email address. Null when the account is unavailable or has been deleted. - `Optional name` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `String userId` Tagged ID of the user. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `JsonValue type = "scoped_api_key_actor"` - `String scopedApiKeyId` - `LocalDateTime createdAt` format: date-time - `BetaSpendLimitPeriod period` - `DAILY("daily")` - `MONTHLY("monthly")` - `WEEKLY("weekly")` - `Optional resolvedAt` format: date-time - `Optional resolvedBy` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `Optional spendSummary` Per-member effective-limit report row (`GET /spend_limits/effective`). - `Actor actor` - `class BetaSpendLimitUserActor` 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. - `class BetaSpendLimitScopedApiKeyActor` A scoped Admin API key acting on behalf of the organization. - `Optional amount` 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. - `String currency` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `BetaSpendLimitPeriod period` Period this row's effective limit and spend are reported for. - `String periodToDateSpend` 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 scope` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `JsonValue type = "user"` Scope type. Always `user` for this scope. - `String userId` Tagged ID of the member the spend limit applies to. - `class BetaSpendLimitSeatTierScope` - `JsonValue type = "seat_tier"` - `String seatTier` - `class BetaSpendLimitRbacGroupScope` - `JsonValue type = "rbac_group"` - `String rbacGroupId` - `class BetaSpendLimitOrganizationServiceScope` - `JsonValue type = "organization_service"` - `String service` - `class BetaSpendLimitOrganizationScope` - `JsonValue type = "organization"` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `JsonValue type = "workspace"` Scope type. Always `workspace` for this scope. - `String workspaceId` Tagged ID of the workspace the spend limit applies to. - `class BetaSpendLimitUsageTierScope` 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. - `JsonValue type = "usage_tier"` Scope type. Always `usage_tier` for this scope. - `Source source` - `class BetaSpendLimitUserScope` Scope selecting a single member of the organization. - `class BetaSpendLimitSeatTierScope` - `class BetaSpendLimitRbacGroupScope` - `class BetaSpendLimitOrganizationServiceScope` - `class BetaSpendLimitOrganizationScope` - `class BetaSpendLimitWorkspaceScope` Scope selecting one workspace of a Claude Console organization. - `class BetaSpendLimitUsageTierScope` 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. - `String spendLimitId` - `BetaSpendLimitIncreaseRequestStatus status` - `APPROVED("approved")` - `DENIED("denied")` - `PENDING("pending")` #### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.organization.spendlimits.increaserequests.BetaSpendLimitIncreaseRequest; import com.anthropic.models.beta.organization.spendlimits.increaserequests.IncreaseRequestDenyParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); BetaSpendLimitIncreaseRequest betaSpendLimitIncreaseRequest = client.beta().organization().spendLimits().increaseRequests().deny("spend_limit_increase_request_id"); } } ``` ##### Response (200) ```json { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "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" }, "status": "approved", "type": "spend_limit_increase_request" } ```