One read of Claude Developer Platformapi-20261001T213726Z
336 pages moved out of 748 read.
Pages moved
336
significant first
Pages read
748
in this capture
Captured
21:37 UTC
Corpus hash
6a28c636443e
index-hash
What this read moved
76-100 of 336, page 4 of 14This capture is too large to show at once. Changes 76-100 of 336 are below, significant first; the rest are on the following screens.
api/beta/organization/plugins/versions Changed · +8 / -0 lines
from line 146
146146
147147 - `"ce-plugins-2026-09-01"`
148148
149 - `"spend-limit-reads-2026-09-26"`
150
149151### Body parameters (form-data)
150152
151153- `files: array of string`
from line 489
487489
488490 - `"ce-plugins-2026-09-01"`
489491
492 - `"spend-limit-reads-2026-09-26"`
493
490494### Returns
491495
492496- `data: array of BetaPluginVersion`
from line 814
810814
811815 - `"ce-plugins-2026-09-01"`
812816
817 - `"spend-limit-reads-2026-09-26"`
818
813819### Returns
814820
815821- `BetaPluginVersion object`
from line 1145
11391145 - `"mcp-client-2026-09-15"`
11401146
11411147 - `"ce-plugins-2026-09-01"`
1148
1149 - `"spend-limit-reads-2026-09-26"`
11421150
11431151### Example
11441152
api/beta/organization/rbac_groups Changed · +146 / -150 lines
### RBAC Group Delete Response ### Beta RBAC Group Deleted
from line 5
55
66# RBAC Groups
77
8## List RBAC Groups
8## Create RBAC Group
99
10**GET** `/v1/organizations/rbac_groups`
10**POST** `/v1/organizations/rbac_groups`
1111
12List RBAC Groups in the Claude Enterprise tenant.
12Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `"direct"`.
1313
1414The RBAC Groups API is available to Claude Enterprise organizations only.
1515
16### Query parameters
16### Body parameters
1717
18- `limit: optional number`
18- `name: string`
1919
20 Number of items to return per page.
20 Name of the RBAC Group. Not uniqueness-enforced.
2121
22 Defaults to `20`. Ranges from `1` to `1000`.
22 minLength: 1, maxLength: 255
2323
24 default: 20, minimum: 1, maximum: 1000
25
26- `page: optional string`
27
28 Optionally set to the `next_page` token from the previous response.
29
3024### Returns
3125
32- `data: array of BetaRBACGroup`
26- `BetaRBACGroup object`
3327
3428 - `type: "rbac_group"`
3529
from line 71
7771
7872 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
7973
80- `has_more: boolean`
81
82 Indicates if there are more results in the requested page direction.
83
84- `next_page: string or null`
85
86 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
87
8874### Example
8975
9076```bash
9177curl https://api.anthropic.com/v1/organizations/rbac_groups \
78 -H 'Content-Type: application/json' \
9279 -H 'anthropic-version: 2023-06-01' \
93 -H "X-Api-Key: $ANTHROPIC_API_KEY"
80 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
81 -d '{
82 "name": "Engineering"
83 }'
9484```
9585
9686#### Response (200)
from line 87
9787
9888```json
9989{
100 "data": [
101 {
102 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
103 "created_at": "2024-10-30T23:58:27.427722Z",
104 "name": "Engineering",
105 "role_ids": [
106 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
107 ],
108 "roles": [
109 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
110 ],
111 "source_type": "direct",
112 "type": "rbac_group",
113 "updated_at": "2024-10-30T23:58:27.427722Z"
114 }
90 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
91 "created_at": "2024-10-30T23:58:27.427722Z",
92 "name": "Engineering",
93 "role_ids": [
94 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
11595 ],
116 "has_more": false,
117 "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
96 "roles": [
97 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
98 ],
99 "source_type": "direct",
100 "type": "rbac_group",
101 "updated_at": "2024-10-30T23:58:27.427722Z"
118102}
119103```
120104
121## Get RBAC Group
105## List RBAC Groups
122106
123**GET** `/v1/organizations/rbac_groups/{rbac_group_id}`
107**GET** `/v1/organizations/rbac_groups`
124108
125Retrieve an RBAC Group by ID.
109List RBAC Groups in the Claude Enterprise tenant.
126110
127111The RBAC Groups API is available to Claude Enterprise organizations only.
128112
129### Path parameters
113### Query parameters
130114
131- `rbac_group_id: string`
115- `limit: optional number`
132116
133 ID of the RBAC Group.
117 Number of items to return per page.
134118
119 Defaults to `20`. Ranges from `1` to `1000`.
120
121 default: 20, minimum: 1, maximum: 1000
122
123- `page: optional string`
124
125 Optionally set to the `next_page` token from the previous response.
126
135127### Returns
136128
137- `BetaRBACGroup object`
129- `data: array of BetaRBACGroup`
138130
139131 - `type: "rbac_group"`
140132
from line 174
182174
183175 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
184176
177- `has_more: boolean`
178
179 Indicates if there are more results in the requested page direction.
180
181- `next_page: string or null`
182
183 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
184
185185### Example
186186
187187```bash
188curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
188curl https://api.anthropic.com/v1/organizations/rbac_groups \
189189 -H 'anthropic-version: 2023-06-01' \
190190 -H "X-Api-Key: $ANTHROPIC_API_KEY"
191191```
from line 194
194194
195195```json
196196{
197 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
198 "created_at": "2024-10-30T23:58:27.427722Z",
199 "name": "Engineering",
200 "role_ids": [
201 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
197 "data": [
198 {
199 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
200 "created_at": "2024-10-30T23:58:27.427722Z",
201 "name": "Engineering",
202 "role_ids": [
203 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
204 ],
205 "roles": [
206 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
207 ],
208 "source_type": "direct",
209 "type": "rbac_group",
210 "updated_at": "2024-10-30T23:58:27.427722Z"
211 }
202212 ],
203 "roles": [
204 "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s"
205 ],
206 "source_type": "direct",
207 "type": "rbac_group",
208 "updated_at": "2024-10-30T23:58:27.427722Z"
213 "has_more": false,
214 "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9"
209215}
210216```
211217
212## Create RBAC Group
218## Get RBAC Group
213219
214**POST** `/v1/organizations/rbac_groups`
220**GET** `/v1/organizations/rbac_groups/{rbac_group_id}`
215221
216Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `"direct"`.
222Retrieve an RBAC Group by ID.
217223
218224The RBAC Groups API is available to Claude Enterprise organizations only.
219225
220### Body parameters
226### Path parameters
221227
222- `name: string`
228- `rbac_group_id: string`
223229
224 Name of the RBAC Group. Not uniqueness-enforced.
230 ID of the RBAC Group.
225231
226 minLength: 1, maxLength: 255
227
228232### Returns
229233
230234- `BetaRBACGroup object`
from line 282
278282### Example
279283
280284```bash
281curl https://api.anthropic.com/v1/organizations/rbac_groups \
282 -H 'Content-Type: application/json' \
285curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \
283286 -H 'anthropic-version: 2023-06-01' \
284 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
285 -d '{
286 "name": "Engineering"
287 }'
287 -H "X-Api-Key: $ANTHROPIC_API_KEY"
288288```
289289
290290#### Response (200)
from line 425
425425
426426### Returns
427427
428- `BetaRBACGroupDeleted object`
428- `type: "rbac_group_deleted"`
429429
430 - `type: "rbac_group_deleted"`
430 Deleted object type.
431431
432 Deleted object type.
432 For RBAC Groups, this is always `"rbac_group_deleted"`.
433433
434 For RBAC Groups, this is always `"rbac_group_deleted"`.
434 default: rbac_group_deleted
435435
436 default: rbac_group_deleted
436- `id: string`
437437
438 - `id: string`
438 ID of the RBAC Group.
439439
440 ID of the RBAC Group.
441
442440### Example
443441
444442```bash
from line 507
509507
510508 Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included.
511509
512### Beta RBAC Group Deleted
510### RBAC Group Delete Response
513511
514- `BetaRBACGroupDeleted object`
512- `RBACGroupDeleteResponse object`
515513
516514 - `type: "rbac_group_deleted"`
517515
from line 725
727725
728726#### Returns
729727
730- `BetaRBACGroupMemberDeleted object`
728- `type: "rbac_group_member_deleted"`
731729
732 - `type: "rbac_group_member_deleted"`
730 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
733731
734 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
732 default: rbac_group_member_deleted
735733
736 default: rbac_group_member_deleted
734- `rbac_group_id: string`
737735
738 - `rbac_group_id: string`
736 ID of the RBAC Group.
739737
740 ID of the RBAC Group.
738- `user_id: string`
741739
742 - `user_id: string`
740 ID of the User.
743741
744 ID of the User.
742- `group_id: string`
745743
746 - `group_id: string`
744 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
747745
748 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
749
750 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
746 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
751747
752748#### Example
753749
api/beta/organization/rbac_groups/delete Changed · +6 / -8 lines
from line 19
1919
2020## Returns
2121
22- `BetaRBACGroupDeleted object`
22- `type: "rbac_group_deleted"`
2323
24 - `type: "rbac_group_deleted"`
24 Deleted object type.
2525
26 Deleted object type.
26 For RBAC Groups, this is always `"rbac_group_deleted"`.
2727
28 For RBAC Groups, this is always `"rbac_group_deleted"`.
28 default: rbac_group_deleted
2929
30 default: rbac_group_deleted
30- `id: string`
3131
32 - `id: string`
33
34 ID of the RBAC Group.
32 ID of the RBAC Group.
3533
3634## Example
3735
api/beta/organization/rbac_groups/members Changed · +22 / -24 lines
### Member Remove Response ### Beta RBAC Group Member Deleted
from line 205
205205
206206### Returns
207207
208- `BetaRBACGroupMemberDeleted object`
208- `type: "rbac_group_member_deleted"`
209209
210 - `type: "rbac_group_member_deleted"`
210 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
211211
212 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
212 default: rbac_group_member_deleted
213213
214 default: rbac_group_member_deleted
214- `rbac_group_id: string`
215215
216 - `rbac_group_id: string`
216 ID of the RBAC Group.
217217
218 ID of the RBAC Group.
218- `user_id: string`
219219
220 - `user_id: string`
220 ID of the User.
221221
222 ID of the User.
222- `group_id: string`
223223
224 - `group_id: string`
224 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
225225
226 **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
226 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
227227
228 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
229
230228### Example
231229
232230```bash
from line 283
285283
286284 Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
287285
288### Beta RBAC Group Member Deleted
286### Member Remove Response
289287
290- `BetaRBACGroupMemberDeleted object`
288- `MemberRemoveResponse object`
291289
292290 - `type: "rbac_group_member_deleted"`
293291
api/beta/organization/rbac_groups/members/add New page · 85 lines, new page
# Add RBAC Group Member ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Add RBAC Group Member
url: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/add
---
# Add RBAC Group Member
**POST** `/v1/organizations/rbac_groups/{rbac_group_id}/members`
Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
The RBAC Groups API is available to Claude Enterprise organizations only.
## Path parameters
- `rbac_group_id: string`
ID of the RBAC Group.
## Body parameters
- `user_id: string`
ID of the User.
## Returns
- `BetaRBACGroupMember object`
- `type: "rbac_group_member"`
Object type.
For RBAC Group Members, this is always `"rbac_group_member"`.
default: rbac_group_member
- `created_at: string`
RFC 3339 timestamp of when the User was added to the RBAC Group.
format: date-time
- `email: string`
Email of the User.
- `rbac_group_id: string`
ID of the RBAC Group.
- `user_id: string`
ID of the User.
- `group_id: string`
**Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}'
```
### Response (200)
```json
{
"created_at": "2024-10-30T23:58:27.427722Z",
"email": "[email protected]",
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
api/beta/organization/rbac_groups/members/create Page removed · 85 lines, page removed
# Add RBAC Group Member ## Path parameters ## Body parameters ## Returns ## Example ### Response (200)
The page is gone upstream. What it last said is kept here.
api/beta/organization/rbac_groups/members/delete Page removed · 66 lines, page removed
# Remove RBAC Group Member ## Path parameters ## Returns ## Example ### Response (200)
The page is gone upstream. What it last said is kept here.
api/beta/organization/rbac_groups/members/remove New page · 64 lines, new page
# Remove RBAC Group Member ## Path parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Remove RBAC Group Member
url: https://platform.claude.com/docs/en/api/beta/organization/rbac_groups/members/remove
---
# Remove RBAC Group Member
**DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}`
Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
The RBAC Groups API is available to Claude Enterprise organizations only.
## Path parameters
- `rbac_group_id: string`
ID of the RBAC Group.
- `user_id: string`
ID of the User.
## Returns
- `type: "rbac_group_member_deleted"`
Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.
default: rbac_group_member_deleted
- `rbac_group_id: string`
ID of the RBAC Group.
- `user_id: string`
ID of the User.
- `group_id: string`
**Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value.
Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`.
## Example
```bash
curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members/$USER_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### Response (200)
```json
{
"group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
"type": "rbac_group_member_deleted",
"user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
}
```
api/beta/organization/rbac_roles Changed · +6 / -6 lines
from line 255
255255 `all_connectors` grants carry a tool-access action, the scope action, or
256256 an authentication-method action (`interactive` or `managed`).
257257
258 - `resource: Organization or ConnectorTool or ConnectorScope or 2 more`
258 - `resource: BetaRBACOrganizationPermissionResource or BetaRBACConnectorToolPermissionResource or BetaRBACConnectorScopePermissionResource or 2 more`
259259
260260 What the permission applies to.
261261
from line 262
262262 A tagged union: `type` names the kind of resource and determines which
263263 identifier fields are present.
264264
265 - `Organization object`
265 - `BetaRBACOrganizationPermissionResource object`
266266
267267 - `type: "organization"`
268268
from line 274
274274
275275 UUID of the organization the permission applies to.
276276
277 - `ConnectorTool object`
277 - `BetaRBACConnectorToolPermissionResource object`
278278
279279 - `type: "connector_tool"`
280280
from line 295
295295 `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus
296296 a hash — from which the published name is not recoverable.
297297
298 - `ConnectorScope object`
298 - `BetaRBACConnectorScopePermissionResource object`
299299
300300 - `type: "connector_scope"`
301301
from line 317
317317 appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth
318318 scopes routinely contain `:` and `/`, so most appear encoded.
319319
320 - `Connector object`
320 - `BetaRBACConnectorPermissionResource object`
321321
322322 - `type: "connector"`
323323
from line 329
329329
330330 ID of the connector the permission applies to.
331331
332 - `AllConnectors object`
332 - `BetaRBACAllConnectorsPermissionResource object`
333333
334334 - `type: "all_connectors"`
335335
api/beta/organization/rbac_roles/permissions Changed · +97 / -12 lines
### Beta RBAC All Connectors Permission Resource ### Beta RBAC Connector Permission Resource ### Beta RBAC Connector Scope Permission Resource ### Beta RBAC Connector Tool Permission Resource ### Beta RBAC Organization Permission Resource
from line 64
6464 `all_connectors` grants carry a tool-access action, the scope action, or
6565 an authentication-method action (`interactive` or `managed`).
6666
67 - `resource: Organization or ConnectorTool or ConnectorScope or 2 more`
67 - `resource: BetaRBACOrganizationPermissionResource or BetaRBACConnectorToolPermissionResource or BetaRBACConnectorScopePermissionResource or 2 more`
6868
6969 What the permission applies to.
7070
from line 71
7171 A tagged union: `type` names the kind of resource and determines which
7272 identifier fields are present.
7373
74 - `Organization object`
74 - `BetaRBACOrganizationPermissionResource object`
7575
7676 - `type: "organization"`
7777
from line 83
8383
8484 UUID of the organization the permission applies to.
8585
86 - `ConnectorTool object`
86 - `BetaRBACConnectorToolPermissionResource object`
8787
8888 - `type: "connector_tool"`
8989
from line 104
104104 `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus
105105 a hash — from which the published name is not recoverable.
106106
107 - `ConnectorScope object`
107 - `BetaRBACConnectorScopePermissionResource object`
108108
109109 - `type: "connector_scope"`
110110
from line 126
126126 appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth
127127 scopes routinely contain `:` and `/`, so most appear encoded.
128128
129 - `Connector object`
129 - `BetaRBACConnectorPermissionResource object`
130130
131131 - `type: "connector"`
132132
from line 138
138138
139139 ID of the connector the permission applies to.
140140
141 - `AllConnectors object`
141 - `BetaRBACAllConnectorsPermissionResource object`
142142
143143 - `type: "all_connectors"`
144144
from line 184
184184
185185## Domain types
186186
187### Beta RBAC All Connectors Permission Resource
188
189- `BetaRBACAllConnectorsPermissionResource object`
190
191 - `type: "all_connectors"`
192
193 Kind of resource the permission applies to.
194
195 default: all_connectors
196
197### Beta RBAC Connector Permission Resource
198
199- `BetaRBACConnectorPermissionResource object`
200
201 - `type: "connector"`
202
203 Kind of resource the permission applies to.
204
205 default: connector
206
207 - `connector_id: string`
208
209 ID of the connector the permission applies to.
210
211### Beta RBAC Connector Scope Permission Resource
212
213- `BetaRBACConnectorScopePermissionResource object`
214
215 - `type: "connector_scope"`
216
217 Kind of resource the permission applies to.
218
219 default: connector_scope
220
221 - `connector_id: string`
222
223 ID of the connector the permission applies to.
224
225 - `scope: string`
226
227 OAuth scope the permission names — the role may receive this scope when
228 tokens are minted for the connector.
229
230 Subject to the same encoding rule as `tool_name`: a scope containing
231 characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form)
232 appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth
233 scopes routinely contain `:` and `/`, so most appear encoded.
234
235### Beta RBAC Connector Tool Permission Resource
236
237- `BetaRBACConnectorToolPermissionResource object`
238
239 - `type: "connector_tool"`
240
241 Kind of resource the permission applies to.
242
243 default: connector_tool
244
245 - `connector_id: string`
246
247 ID of the connector the permission applies to.
248
249 - `tool_name: string`
250
251 Published name of the connector tool the permission applies to.
252
253 When the published name contains characters outside `[a-zA-Z0-9_-]` (or
254 collides with a reserved form), it is server-encoded into a stable
255 `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus
256 a hash — from which the published name is not recoverable.
257
258### Beta RBAC Organization Permission Resource
259
260- `BetaRBACOrganizationPermissionResource object`
261
262 - `type: "organization"`
263
264 Kind of resource the permission applies to.
265
266 default: organization
267
268 - `organization_id: string`
269
270 UUID of the organization the permission applies to.
271
187272### Beta RBAC Role Permission
188273
189274- `BetaRBACRolePermission object`
from line 300
215300 `all_connectors` grants carry a tool-access action, the scope action, or
216301 an authentication-method action (`interactive` or `managed`).
217302
218 - `resource: Organization or ConnectorTool or ConnectorScope or 2 more`
303 - `resource: BetaRBACOrganizationPermissionResource or BetaRBACConnectorToolPermissionResource or BetaRBACConnectorScopePermissionResource or 2 more`
219304
220305 What the permission applies to.
221306
from line 307
222307 A tagged union: `type` names the kind of resource and determines which
223308 identifier fields are present.
224309
225 - `Organization object`
310 - `BetaRBACOrganizationPermissionResource object`
226311
227312 - `type: "organization"`
228313
from line 319
234319
235320 UUID of the organization the permission applies to.
236321
237 - `ConnectorTool object`
322 - `BetaRBACConnectorToolPermissionResource object`
238323
239324 - `type: "connector_tool"`
240325
from line 340
255340 `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus
256341 a hash — from which the published name is not recoverable.
257342
258 - `ConnectorScope object`
343 - `BetaRBACConnectorScopePermissionResource object`
259344
260345 - `type: "connector_scope"`
261346
from line 362
277362 appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth
278363 scopes routinely contain `:` and `/`, so most appear encoded.
279364
280 - `Connector object`
365 - `BetaRBACConnectorPermissionResource object`
281366
282367 - `type: "connector"`
283368
from line 374
289374
290375 ID of the connector the permission applies to.
291376
292 - `AllConnectors object`
377 - `BetaRBACAllConnectorsPermissionResource object`
293378
294379 - `type: "all_connectors"`
295380
api/beta/organization/rbac_roles/permissions/list Changed · +6 / -6 lines
from line 62
6262 `all_connectors` grants carry a tool-access action, the scope action, or
6363 an authentication-method action (`interactive` or `managed`).
6464
65 - `resource: Organization or ConnectorTool or ConnectorScope or 2 more`
65 - `resource: BetaRBACOrganizationPermissionResource or BetaRBACConnectorToolPermissionResource or BetaRBACConnectorScopePermissionResource or 2 more`
6666
6767 What the permission applies to.
6868
from line 69
6969 A tagged union: `type` names the kind of resource and determines which
7070 identifier fields are present.
7171
72 - `Organization object`
72 - `BetaRBACOrganizationPermissionResource object`
7373
7474 - `type: "organization"`
7575
from line 81
8181
8282 UUID of the organization the permission applies to.
8383
84 - `ConnectorTool object`
84 - `BetaRBACConnectorToolPermissionResource object`
8585
8686 - `type: "connector_tool"`
8787
from line 102
102102 `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus
103103 a hash — from which the published name is not recoverable.
104104
105 - `ConnectorScope object`
105 - `BetaRBACConnectorScopePermissionResource object`
106106
107107 - `type: "connector_scope"`
108108
from line 124
124124 appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth
125125 scopes routinely contain `:` and `/`, so most appear encoded.
126126
127 - `Connector object`
127 - `BetaRBACConnectorPermissionResource object`
128128
129129 - `type: "connector"`
130130
from line 136
136136
137137 ID of the connector the permission applies to.
138138
139 - `AllConnectors object`
139 - `BetaRBACAllConnectorsPermissionResource object`
140140
141141 - `type: "all_connectors"`
142142
api/beta/organization/service_accounts Changed · +16 / -0 lines
from line 127
127127
128128 - `"ce-plugins-2026-09-01"`
129129
130 - `"spend-limit-reads-2026-09-26"`
131
130132### Body parameters
131133
132134- `name: string`
from line 380
378380
379381 - `"ce-plugins-2026-09-01"`
380382
383 - `"spend-limit-reads-2026-09-26"`
384
381385### Returns
382386
383387- `data: array of BetaServiceAccount`
from line 595
591595
592596 - `"ce-plugins-2026-09-01"`
593597
598 - `"spend-limit-reads-2026-09-26"`
599
594600### Returns
595601
596602- `BetaServiceAccount object`
from line 811
805811
806812 - `"ce-plugins-2026-09-01"`
807813
814 - `"spend-limit-reads-2026-09-26"`
815
808816### Body parameters
809817
810818- `description: optional string or null`
from line 1045
10371045
10381046 - `"ce-plugins-2026-09-01"`
10391047
1048 - `"spend-limit-reads-2026-09-26"`
1049
10401050### Returns
10411051
10421052- `BetaServiceAccount object`
from line 1369
13591369
13601370 - `"ce-plugins-2026-09-01"`
13611371
1372 - `"spend-limit-reads-2026-09-26"`
1373
13621374#### Body parameters
13631375
13641376- `workspace_id: string`
from line 1599
15871599
15881600 - `"ce-plugins-2026-09-01"`
15891601
1602 - `"spend-limit-reads-2026-09-26"`
1603
15901604#### Returns
15911605
15921606- `data: array of BetaServiceAccountWorkspaceMember`
from line 1800
17861800 - `"mcp-client-2026-09-15"`
17871801
17881802 - `"ce-plugins-2026-09-01"`
1803
1804 - `"spend-limit-reads-2026-09-26"`
17891805
17901806#### Returns
17911807
api/beta/organization/service_accounts/workspaces Changed · +6 / -0 lines
from line 132
132132
133133 - `"ce-plugins-2026-09-01"`
134134
135 - `"spend-limit-reads-2026-09-26"`
136
135137### Body parameters
136138
137139- `workspace_id: string`
from line 362
360362
361363 - `"ce-plugins-2026-09-01"`
362364
365 - `"spend-limit-reads-2026-09-26"`
366
363367### Returns
364368
365369- `data: array of BetaServiceAccountWorkspaceMember`
from line 563
559563 - `"mcp-client-2026-09-15"`
560564
561565 - `"ce-plugins-2026-09-01"`
566
567 - `"spend-limit-reads-2026-09-26"`
562568
563569### Returns
564570
api/beta/organization/spend_limits Changed · +1149 / -1253 lines
## List Spend Limits ### Headers ### Beta Spend Limit Organization Scope ### Beta Spend Limit Organization Service Scope ### Beta Spend Limit RBAC Group Scope ### Beta Spend Limit Scoped API Key Actor ### Beta Spend Limit Seat Tier Scope ### Beta Spend Limit User Actor ### Beta Spend Limit User Scope ### Beta Spend Limit Workspace Scope ## Spend Limits › Effective ### List Effective Spend Limits ## List Effective Spend Limits
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 25
2525
2626 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.
2727
28- `scope: User or Organization or Workspace`
28- `scope: BetaSpendLimitUserScope or BetaSpendLimitOrganizationScope or BetaSpendLimitWorkspaceScope`
2929
3030 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.
3131
32 - `User object`
32 - `BetaSpendLimitUserScope object`
3333
3434 Scope selecting a single member of the organization.
3535
from line 43
4343
4444 Tagged ID of the member the spend limit applies to.
4545
46 - `Organization object`
46 - `BetaSpendLimitOrganizationScope object`
4747
4848 - `type: "organization"`
4949
5050 default: organization
5151
52 - `Workspace object`
52 - `BetaSpendLimitWorkspaceScope object`
5353
5454 Scope selecting one workspace of a Claude Console organization.
5555
from line 101
101101
102102 ISO 4217 code of the organization's billing currency; the unit for `amount`.
103103
104 - `is_enabled: boolean`
105
106 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.
107
104108 - `period: BetaSpendLimitPeriod`
105109
106110 Length of the window the limit resets over. `amount` caps spend within each period.
from line 115
111115
112116 - `"weekly"`
113117
114 - `scope: User or SeatTier or RBACGroup or 3 more`
118 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
115119
116120 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
117121
118 - `User object`
122 - `BetaSpendLimitUserScope object`
119123
120124 Scope selecting a single member of the organization.
121125
from line 133
129133
130134 Tagged ID of the member the spend limit applies to.
131135
132 - `SeatTier object`
136 - `BetaSpendLimitSeatTierScope object`
133137
134138 - `type: "seat_tier"`
135139
from line 141
137141
138142 - `seat_tier: string`
139143
140 - `RBACGroup object`
144 - `BetaSpendLimitRBACGroupScope object`
141145
142146 - `type: "rbac_group"`
143147
from line 149
145149
146150 - `rbac_group_id: string`
147151
148 - `OrganizationService object`
152 - `BetaSpendLimitOrganizationServiceScope object`
149153
150154 - `type: "organization_service"`
151155
from line 157
153157
154158 - `service: string`
155159
156 - `Organization object`
160 - `BetaSpendLimitOrganizationScope object`
157161
158162 - `type: "organization"`
159163
160164 default: organization
161165
162 - `Workspace object`
166 - `BetaSpendLimitWorkspaceScope object`
163167
164168 Scope selecting one workspace of a Claude Console organization.
165169
from line 208
204208 "amount": "50000",
205209 "created_at": "2019-12-27T18:11:19.117Z",
206210 "currency": "USD",
211 "is_enabled": true,
207212 "period": "daily",
208213 "scope": {
209214 "type": "user",
from line 261
256261
257262 ISO 4217 code of the organization's billing currency; the unit for `amount`.
258263
264 - `is_enabled: boolean`
265
266 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.
267
259268 - `period: BetaSpendLimitPeriod`
260269
261270 Length of the window the limit resets over. `amount` caps spend within each period.
from line 275
266275
267276 - `"weekly"`
268277
269 - `scope: User or SeatTier or RBACGroup or 3 more`
278 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
270279
271280 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
272281
273 - `User object`
282 - `BetaSpendLimitUserScope object`
274283
275284 Scope selecting a single member of the organization.
276285
from line 293
284293
285294 Tagged ID of the member the spend limit applies to.
286295
287 - `SeatTier object`
296 - `BetaSpendLimitSeatTierScope object`
288297
289298 - `type: "seat_tier"`
290299
from line 301
292301
293302 - `seat_tier: string`
294303
295 - `RBACGroup object`
304 - `BetaSpendLimitRBACGroupScope object`
296305
297306 - `type: "rbac_group"`
298307
from line 309
300309
301310 - `rbac_group_id: string`
302311
303 - `OrganizationService object`
312 - `BetaSpendLimitOrganizationServiceScope object`
304313
305314 - `type: "organization_service"`
306315
from line 317
308317
309318 - `service: string`
310319
311 - `Organization object`
320 - `BetaSpendLimitOrganizationScope object`
312321
313322 - `type: "organization"`
314323
315324 default: organization
316325
317 - `Workspace object`
326 - `BetaSpendLimitWorkspaceScope object`
318327
319328 Scope selecting one workspace of a Claude Console organization.
320329
from line 359
350359 "amount": "50000",
351360 "created_at": "2019-12-27T18:11:19.117Z",
352361 "currency": "USD",
362 "is_enabled": true,
353363 "period": "daily",
354364 "scope": {
355365 "type": "user",
from line 414
404414}
405415```
406416
407## List Effective Spend Limits
417## List Spend Limits
418
419**GET** `/v1/organizations/spend_limits`
420
421List the organization's spend limits.
422
423A Claude Console organization's limits come in an order that is stable across
424pages. A Claude Enterprise organization's are grouped by scope type,
425in the order `organization`, `seat_tier`, `rbac_group`,
426`organization_service`, `user`; within a type they come in a fixed order that
427is not creation order.
428
429### Query parameters
430
431- `limit: optional number`
432
433 Maximum number of limits per page. Defaults to `20`.
434
435 default: 20, minimum: 1, maximum: 1000
436
437- `page: optional string`
438
439 Opaque cursor from a previous response's `next_page` field.
440
441- `scope_type: optional array of "organization" or "organization_service" or "rbac_group" or 3 more`
442
443 Return only limits with these scope types. A Claude Console organization has `organization` and `workspace` limits; a Claude Enterprise organization has `organization`, `seat_tier`, `rbac_group`, `organization_service` and `user` limits. Omit for all.
444
445 maxItems: 6
446
447 - `"organization"`
448
449 - `"organization_service"`
450
451 - `"rbac_group"`
452
453 - `"seat_tier"`
454
455 - `"user"`
456
457 - `"workspace"`
458
459### Headers
460
461- `"anthropic-beta": optional array of AnthropicBeta`
462
463 This endpoint is in beta: requests must send `spend-limit-reads-2026-09-26` in this header.
464
465 - `string`
466
467 - `"message-batches-2024-09-24"`
468
469 - `"prompt-caching-2024-07-31"`
470
471 - `"computer-use-2024-10-22"`
472
473 - `"computer-use-2025-01-24"`
474
475 - `"pdfs-2024-09-25"`
476
477 - `"token-counting-2024-11-01"`
478
479 - `"token-efficient-tools-2025-02-19"`
480
481 - `"output-128k-2025-02-19"`
482
483 - `"files-api-2025-04-14"`
484
485 - `"mcp-client-2025-04-04"`
486
487 - `"mcp-client-2025-11-20"`
488
489 - `"dev-full-thinking-2025-05-14"`
490
491 - `"interleaved-thinking-2025-05-14"`
492
493 - `"code-execution-2025-05-22"`
494
495 - `"extended-cache-ttl-2025-04-11"`
496
497 - `"context-1m-2025-08-07"`
498
499 - `"context-management-2025-06-27"`
500
501 - `"model-context-window-exceeded-2025-08-26"`
502
503 - `"skills-2025-10-02"`
504
505 - `"fast-mode-2026-02-01"`
506
507 - `"output-300k-2026-03-24"`
508
509 - `"user-profiles-2026-03-24"`
510
511 - `"user-profiles-2026-08-18"`
512
513 - `"user-profiles-2026-09-04"`
514
515 - `"advisor-tool-2026-03-01"`
516
517 - `"managed-agents-2026-04-01"`
518
519 - `"cache-diagnosis-2026-04-07"`
520
521 - `"dreaming-2026-04-21"`
522
523 - `"thinking-token-count-2026-05-13"`
524
525 - `"server-side-fallback-2026-06-01"`
526
527 - `"server-side-fallback-2026-07-01"`
528
529 - `"fallback-credit-2026-06-01"`
530
531 - `"fallback-credit-2026-07-01"`
532
533 - `"agent-memory-2026-07-22"`
534
535 - `"mid-conversation-tool-changes-2026-07-01"`
536
537 - `"compact-2026-01-12"`
538
539 - `"computer-use-2025-11-24"`
540
541 - `"mcp-tunnels-2026-06-22"`
542
543 - `"structured-outputs-2025-11-13"`
544
545 - `"task-budgets-2026-03-13"`
546
547 - `"thinking-display-updates-2026-08-18"`
548
549 - `"ce-user-management-2026-07-13"`
550
551 - `"mid-conversation-output-config-2026-07-01"`
552
553 - `"thinking-binding-controls-2026-08-01"`
554
555 - `"mid-conversation-system-clear-at-2026-08-21"`
556
557 - `"compact-2026-09-04"`
558
559 - `"inline-tools-2026-09-15"`
560
561 - `"mcp-client-2026-09-15"`
562
563 - `"ce-plugins-2026-09-01"`
564
565 - `"spend-limit-reads-2026-09-26"`
566
567### Returns
568
569- `data: array of BetaSpendLimit`
570
571 - `type: "spend_limit"`
572
573 Object type. Always `spend_limit`.
574
575 default: spend_limit
576
577 - `id: string`
578
579 Unique tagged ID of the spend limit (`spl_...`).
580
581 - `amount: string or null`
582
583 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.
584
585 - `created_at: string`
586
587 RFC 3339 datetime at which the spend limit was created.
588
589 format: date-time
590
591 - `currency: string`
592
593 ISO 4217 code of the organization's billing currency; the unit for `amount`.
594
595 - `is_enabled: boolean`
596
597 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.
598
599 - `period: BetaSpendLimitPeriod`
600
601 Length of the window the limit resets over. `amount` caps spend within each period.
602
603 - `"daily"`
604
605 - `"monthly"`
606
607 - `"weekly"`
608
609 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
610
611 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
612
613 - `BetaSpendLimitUserScope object`
614
615 Scope selecting a single member of the organization.
616
617 - `type: "user"`
618
619 Scope type. Always `user` for this scope.
620
621 default: user
622
623 - `user_id: string`
624
625 Tagged ID of the member the spend limit applies to.
626
627 - `BetaSpendLimitSeatTierScope object`
628
629 - `type: "seat_tier"`
630
631 default: seat_tier
632
633 - `seat_tier: string`
634
635 - `BetaSpendLimitRBACGroupScope object`
636
637 - `type: "rbac_group"`
638
639 default: rbac_group
640
641 - `rbac_group_id: string`
642
643 - `BetaSpendLimitOrganizationServiceScope object`
644
645 - `type: "organization_service"`
646
647 default: organization_service
648
649 - `service: string`
650
651 - `BetaSpendLimitOrganizationScope object`
652
653 - `type: "organization"`
654
655 default: organization
656
657 - `BetaSpendLimitWorkspaceScope object`
658
659 Scope selecting one workspace of a Claude Console organization.
660
661 - `type: "workspace"`
662
663 Scope type. Always `workspace` for this scope.
664
665 default: workspace
666
667 - `workspace_id: string`
668
669 Tagged ID of the workspace the spend limit applies to.
670
671 - `updated_at: string`
672
673 RFC 3339 datetime at which the spend limit was last modified.
674
675 format: date-time
676
677- `next_page: string or null`
678
679### Example
680
681```bash
682curl https://api.anthropic.com/v1/organizations/spend_limits \
683 -H 'anthropic-version: 2023-06-01' \
684 -H 'anthropic-beta: spend-limit-reads-2026-09-26' \
685 -H "X-Api-Key: $ANTHROPIC_API_KEY"
686```
687
688#### Response (200)
689
690```json
691{
692 "data": [
693 {
694 "id": "id",
695 "amount": "50000",
696 "created_at": "2019-12-27T18:11:19.117Z",
697 "currency": "USD",
698 "is_enabled": true,
699 "period": "daily",
700 "scope": {
701 "type": "user",
702 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
703 },
704 "type": "spend_limit",
705 "updated_at": "2019-12-27T18:11:19.117Z"
706 }
707 ],
708 "next_page": "next_page"
709}
710```
711
712## Domain types
713
714### Beta Spend Limit
715
716- `BetaSpendLimit object`
717
718 A configured spend limit: a cap on metered spend for one scope and period.
719
720 - `type: "spend_limit"`
721
722 Object type. Always `spend_limit`.
723
724 default: spend_limit
725
726 - `id: string`
727
728 Unique tagged ID of the spend limit (`spl_...`).
729
730 - `amount: string or null`
731
732 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.
733
734 - `created_at: string`
735
736 RFC 3339 datetime at which the spend limit was created.
737
738 format: date-time
739
740 - `currency: string`
741
742 ISO 4217 code of the organization's billing currency; the unit for `amount`.
743
744 - `is_enabled: boolean`
745
746 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.
747
748 - `period: BetaSpendLimitPeriod`
749
750 Length of the window the limit resets over. `amount` caps spend within each period.
751
752 - `"daily"`
753
754 - `"monthly"`
755
756 - `"weekly"`
757
758 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
759
760 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
761
762 - `BetaSpendLimitUserScope object`
763
764 Scope selecting a single member of the organization.
765
766 - `type: "user"`
767
768 Scope type. Always `user` for this scope.
769
770 default: user
771
772 - `user_id: string`
773
774 Tagged ID of the member the spend limit applies to.
775
776 - `BetaSpendLimitSeatTierScope object`
777
778 - `type: "seat_tier"`
779
780 default: seat_tier
781
782 - `seat_tier: string`
783
784 - `BetaSpendLimitRBACGroupScope object`
785
786 - `type: "rbac_group"`
787
788 default: rbac_group
789
790 - `rbac_group_id: string`
791
792 - `BetaSpendLimitOrganizationServiceScope object`
793
794 - `type: "organization_service"`
795
796 default: organization_service
797
798 - `service: string`
799
800 - `BetaSpendLimitOrganizationScope object`
801
802 - `type: "organization"`
803
804 default: organization
805
806 - `BetaSpendLimitWorkspaceScope object`
807
808 Scope selecting one workspace of a Claude Console organization.
809
810 - `type: "workspace"`
811
812 Scope type. Always `workspace` for this scope.
813
814 default: workspace
815
816 - `workspace_id: string`
817
818 Tagged ID of the workspace the spend limit applies to.
819
820 - `updated_at: string`
821
822 RFC 3339 datetime at which the spend limit was last modified.
823
824 format: date-time
825
826### Beta Spend Limit Organization Scope
827
828- `BetaSpendLimitOrganizationScope object`
829
830 - `type: "organization"`
831
832 default: organization
833
834### Beta Spend Limit Organization Service Scope
835
836- `BetaSpendLimitOrganizationServiceScope object`
837
838 - `type: "organization_service"`
839
840 default: organization_service
841
842 - `service: string`
843
844### Beta Spend Limit Period
845
846- `BetaSpendLimitPeriod = "daily" or "monthly" or "weekly"`
847
848 - `"daily"`
849
850 - `"monthly"`
851
852 - `"weekly"`
853
854### Beta Spend Limit RBAC Group Scope
855
856- `BetaSpendLimitRBACGroupScope object`
857
858 - `type: "rbac_group"`
859
860 default: rbac_group
861
862 - `rbac_group_id: string`
863
864### Beta Spend Limit Scoped API Key Actor
865
866- `BetaSpendLimitScopedAPIKeyActor object`
867
868 A scoped Admin API key acting on behalf of the organization.
869
870 - `type: "scoped_api_key_actor"`
871
872 default: scoped_api_key_actor
873
874 - `scoped_api_key_id: string`
875
876### Beta Spend Limit Seat Tier Scope
877
878- `BetaSpendLimitSeatTierScope object`
879
880 - `type: "seat_tier"`
881
882 default: seat_tier
883
884 - `seat_tier: string`
885
886### Beta Spend Limit User Actor
887
888- `BetaSpendLimitUserActor object`
889
890 A user within the organization. `name` and `email_address` are
891 null when the underlying account is unavailable or has been deleted;
892 `deleted` is true only for deleted accounts.
893
894 - `type: "user_actor"`
895
896 Actor type. Always `user_actor`.
897
898 default: user_actor
899
900 - `deleted: boolean`
901
902 True only when the underlying account has been deleted.
903
904 default: false
905
906 - `email_address: string or null`
907
908 The user's email address. Null when the account is unavailable or has been deleted.
909
910 - `name: string or null`
911
912 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
913
914 - `user_id: string`
915
916 Tagged ID of the user.
917
918### Beta Spend Limit User Scope
919
920- `BetaSpendLimitUserScope object`
921
922 Scope selecting a single member of the organization.
923
924 - `type: "user"`
925
926 Scope type. Always `user` for this scope.
927
928 default: user
929
930 - `user_id: string`
931
932 Tagged ID of the member the spend limit applies to.
933
934### Beta Spend Limit Workspace Scope
935
936- `BetaSpendLimitWorkspaceScope object`
937
938 Scope selecting one workspace of a Claude Console organization.
939
940 - `type: "workspace"`
941
942 Scope type. Always `workspace` for this scope.
943
944 default: workspace
945
946 - `workspace_id: string`
947
948 Tagged ID of the workspace the spend limit applies to.
949
950### Beta Spend Summary
951
952- `BetaSpendSummary object`
953
954 Per-member effective-limit report row (`GET /spend_limits/effective`).
955
956 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
957
958 - `BetaSpendLimitUserActor object`
959
960 A user within the organization. `name` and `email_address` are
961 null when the underlying account is unavailable or has been deleted;
962 `deleted` is true only for deleted accounts.
963
964 - `type: "user_actor"`
965
966 Actor type. Always `user_actor`.
967
968 default: user_actor
969
970 - `deleted: boolean`
971
972 True only when the underlying account has been deleted.
973
974 default: false
975
976 - `email_address: string or null`
977
978 The user's email address. Null when the account is unavailable or has been deleted.
979
980 - `name: string or null`
981
982 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
983
984 - `user_id: string`
985
986 Tagged ID of the user.
987
988 - `BetaSpendLimitScopedAPIKeyActor object`
989
990 A scoped Admin API key acting on behalf of the organization.
991
992 - `type: "scoped_api_key_actor"`
993
994 default: scoped_api_key_actor
995
996 - `scoped_api_key_id: string`
997
998 - `amount: string or null`
999
1000 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.
1001
1002 - `currency: string`
1003
1004 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1005
1006 - `period: BetaSpendLimitPeriod`
1007
1008 Period this row's effective limit and spend are reported for.
1009
1010 - `"daily"`
1011
1012 - `"monthly"`
1013
1014 - `"weekly"`
1015
1016 - `period_to_date_spend: string`
1017
1018 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.
1019
1020 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1021
1022 - `BetaSpendLimitUserScope object`
1023
1024 Scope selecting a single member of the organization.
1025
1026 - `type: "user"`
1027
1028 Scope type. Always `user` for this scope.
1029
1030 default: user
1031
1032 - `user_id: string`
1033
1034 Tagged ID of the member the spend limit applies to.
1035
1036 - `BetaSpendLimitSeatTierScope object`
1037
1038 - `type: "seat_tier"`
1039
1040 default: seat_tier
1041
1042 - `seat_tier: string`
1043
1044 - `BetaSpendLimitRBACGroupScope object`
1045
1046 - `type: "rbac_group"`
1047
1048 default: rbac_group
1049
1050 - `rbac_group_id: string`
1051
1052 - `BetaSpendLimitOrganizationServiceScope object`
1053
1054 - `type: "organization_service"`
1055
1056 default: organization_service
1057
1058 - `service: string`
1059
1060 - `BetaSpendLimitOrganizationScope object`
1061
1062 - `type: "organization"`
1063
1064 default: organization
1065
1066 - `BetaSpendLimitWorkspaceScope object`
1067
1068 Scope selecting one workspace of a Claude Console organization.
1069
1070 - `type: "workspace"`
1071
1072 Scope type. Always `workspace` for this scope.
1073
1074 default: workspace
1075
1076 - `workspace_id: string`
1077
1078 Tagged ID of the workspace the spend limit applies to.
1079
1080 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1081
1082 - `BetaSpendLimitUserScope object`
1083
1084 Scope selecting a single member of the organization.
1085
1086 - `BetaSpendLimitSeatTierScope object`
1087
1088 - `BetaSpendLimitRBACGroupScope object`
1089
1090 - `BetaSpendLimitOrganizationServiceScope object`
1091
1092 - `BetaSpendLimitOrganizationScope object`
1093
1094 - `BetaSpendLimitWorkspaceScope object`
1095
1096 Scope selecting one workspace of a Claude Console organization.
1097
1098 - `spend_limit_id: string`
1099
1100### Spend Limit Delete Response
1101
1102- `SpendLimitDeleteResponse object`
1103
1104 - `type: "spend_limit_deleted"`
1105
1106 default: spend_limit_deleted
1107
1108 - `id: string`
1109
1110## Spend Limits › Effective
1111
1112### List Effective Spend Limits
4081113
4091114**GET** `/v1/organizations/spend_limits/effective`
4101115
from line 1119
4141119for, with the `source` scope the spend limit was inherited from.
4151120Paginates by member, so a member's periods never split across pages.
4161121
417### Query parameters
1122#### Query parameters
4181123
4191124- `limit: optional number`
4201125
from line 1149
4441149
4451150 maxItems: 100
4461151
447### Returns
1152#### Returns
4481153
4491154- `data: array of BetaSpendSummary`
4501155
451 - `actor: UserActor or ScopedAPIKeyActor`
452
453 - `UserActor object`
1156 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1157
1158 - `BetaSpendLimitUserActor object`
4541159
4551160 A user within the organization. `name` and `email_address` are
4561161 null when the underlying account is unavailable or has been deleted;
from line 1185
4801185
4811186 Tagged ID of the user.
4821187
483 - `ScopedAPIKeyActor object`
1188 - `BetaSpendLimitScopedAPIKeyActor object`
4841189
4851190 A scoped Admin API key acting on behalf of the organization.
4861191
from line 1217
5121217
5131218 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.
5141219
515 - `scope: User or SeatTier or RBACGroup or 3 more`
516
517 - `User object`
1220 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1221
1222 - `BetaSpendLimitUserScope object`
5181223
5191224 Scope selecting a single member of the organization.
5201225
from line 1233
5281233
5291234 Tagged ID of the member the spend limit applies to.
5301235
531 - `SeatTier object`
1236 - `BetaSpendLimitSeatTierScope object`
5321237
5331238 - `type: "seat_tier"`
5341239
from line 1241
5361241
5371242 - `seat_tier: string`
5381243
539 - `RBACGroup object`
1244 - `BetaSpendLimitRBACGroupScope object`
5401245
5411246 - `type: "rbac_group"`
5421247
from line 1249
5441249
5451250 - `rbac_group_id: string`
5461251
547 - `OrganizationService object`
1252 - `BetaSpendLimitOrganizationServiceScope object`
5481253
5491254 - `type: "organization_service"`
5501255
from line 1257
5521257
5531258 - `service: string`
5541259
555 - `Organization object`
1260 - `BetaSpendLimitOrganizationScope object`
5561261
5571262 - `type: "organization"`
5581263
5591264 default: organization
5601265
561 - `Workspace object`
1266 - `BetaSpendLimitWorkspaceScope object`
5621267
5631268 Scope selecting one workspace of a Claude Console organization.
5641269
from line 1277
5721277
5731278 Tagged ID of the workspace the spend limit applies to.
5741279
575 - `source: User or SeatTier or RBACGroup or 3 more`
576
577 - `User object`
1280 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1281
1282 - `BetaSpendLimitUserScope object`
5781283
5791284 Scope selecting a single member of the organization.
5801285
581 - `type: "user"`
582
583 Scope type. Always `user` for this scope.
584
585 default: user
586
587 - `user_id: string`
588
589 Tagged ID of the member the spend limit applies to.
590
591 - `SeatTier object`
592
593 - `type: "seat_tier"`
594
595 default: seat_tier
596
597 - `seat_tier: string`
598
599 - `RBACGroup object`
600
601 - `type: "rbac_group"`
602
603 default: rbac_group
604
605 - `rbac_group_id: string`
606
607 - `OrganizationService object`
608
609 - `type: "organization_service"`
610
611 default: organization_service
612
613 - `service: string`
614
615 - `Organization object`
616
617 - `type: "organization"`
618
619 default: organization
620
621 - `Workspace object`
1286 - `BetaSpendLimitSeatTierScope object`
1287
1288 - `BetaSpendLimitRBACGroupScope object`
1289
1290 - `BetaSpendLimitOrganizationServiceScope object`
1291
1292 - `BetaSpendLimitOrganizationScope object`
1293
1294 - `BetaSpendLimitWorkspaceScope object`
6221295
6231296 Scope selecting one workspace of a Claude Console organization.
6241297
625 - `type: "workspace"`
626
627 Scope type. Always `workspace` for this scope.
628
629 default: workspace
630
631 - `workspace_id: string`
632
633 Tagged ID of the workspace the spend limit applies to.
634
6351298 - `spend_limit_id: string`
6361299
6371300- `next_page: string or null`
6381301
639### Example
1302#### Example
6401303
6411304```bash
6421305curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
from line 1307
6441307 -H "X-Api-Key: $ANTHROPIC_API_KEY"
6451308```
6461309
647#### Response (200)
1310##### Response (200)
6481311
6491312```json
6501313{
from line 1339
6761339}
6771340```
6781341
679## Domain types
680
681### Beta Spend Limit
682
683- `BetaSpendLimit object`
684
685 A configured spend limit: a cap on metered spend for one scope and period.
686
687 - `type: "spend_limit"`
688
689 Object type. Always `spend_limit`.
690
691 default: spend_limit
1342## Spend Limits › Increase Requests
1343
1344### List Spend Limit Increase Requests
1345
1346**GET** `/v1/organizations/spend_limit_increase_requests`
1347
1348List spend limit increase requests, most recent first.
1349
1350Pending requests include a live `spend_summary` for the requester.
1351Requests whose requester is no longer a member are excluded.
1352
1353#### Query parameters
1354
1355- `actor_ids: optional array of string`
1356
1357 Filter by requester, as `user_...` tagged IDs.
1358
1359- `limit: optional number`
1360
1361 default: 20, minimum: 1, maximum: 1000
1362
1363- `page: optional string`
1364
1365 Opaque cursor from a previous response's `next_page`.
1366
1367- `status: optional array of BetaSpendLimitIncreaseRequestStatus`
1368
1369 Filter by status. Omit to return all.
1370
1371 - `"approved"`
1372
1373 - `"denied"`
1374
1375 - `"pending"`
1376
1377#### Returns
1378
1379- `data: array of BetaSpendLimitIncreaseRequest`
1380
1381 - `type: "spend_limit_increase_request"`
1382
1383 default: spend_limit_increase_request
6921384
6931385 - `id: string`
6941386
695 Unique tagged ID of the spend limit (`spl_...`).
696
697 - `amount: string or null`
698
699 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.
700
701 - `created_at: string`
702
703 RFC 3339 datetime at which the spend limit was created.
704
705 format: date-time
706
707 - `currency: string`
708
709 ISO 4217 code of the organization's billing currency; the unit for `amount`.
710
711 - `period: BetaSpendLimitPeriod`
712
713 Length of the window the limit resets over. `amount` caps spend within each period.
714
715 - `"daily"`
716
717 - `"monthly"`
718
719 - `"weekly"`
720
721 - `scope: User or SeatTier or RBACGroup or 3 more`
722
723 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
724
725 - `User object`
726
727 Scope selecting a single member of the organization.
728
729 - `type: "user"`
730
731 Scope type. Always `user` for this scope.
732
733 default: user
734
735 - `user_id: string`
736
737 Tagged ID of the member the spend limit applies to.
738
739 - `SeatTier object`
740
741 - `type: "seat_tier"`
742
743 default: seat_tier
744
745 - `seat_tier: string`
746
747 - `RBACGroup object`
748
749 - `type: "rbac_group"`
750
751 default: rbac_group
752
753 - `rbac_group_id: string`
754
755 - `OrganizationService object`
756
757 - `type: "organization_service"`
758
759 default: organization_service
760
761 - `service: string`
762
763 - `Organization object`
764
765 - `type: "organization"`
766
767 default: organization
768
769 - `Workspace object`
770
771 Scope selecting one workspace of a Claude Console organization.
772
773 - `type: "workspace"`
774
775 Scope type. Always `workspace` for this scope.
776
777 default: workspace
778
779 - `workspace_id: string`
780
781 Tagged ID of the workspace the spend limit applies to.
782
783 - `updated_at: string`
784
785 RFC 3339 datetime at which the spend limit was last modified.
786
787 format: date-time
788
789### Beta Spend Limit Period
790
791- `BetaSpendLimitPeriod = "daily" or "monthly" or "weekly"`
792
793 - `"daily"`
794
795 - `"monthly"`
796
797 - `"weekly"`
798
799### Beta Spend Summary
800
801- `BetaSpendSummary object`
802
803 Per-member effective-limit report row (`GET /spend_limits/effective`).
804
805 - `actor: UserActor or ScopedAPIKeyActor`
806
807 - `UserActor object`
1387 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1388
1389 - `BetaSpendLimitUserActor object`
8081390
8091391 A user within the organization. `name` and `email_address` are
8101392 null when the underlying account is unavailable or has been deleted;
from line 1416
8341416
8351417 Tagged ID of the user.
8361418
837 - `ScopedAPIKeyActor object`
1419 - `BetaSpendLimitScopedAPIKeyActor object`
8381420
8391421 A scoped Admin API key acting on behalf of the organization.
8401422
from line 1426
8441426
8451427 - `scoped_api_key_id: string`
8461428
847 - `amount: string or null`
848
849 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.
850
851 - `currency: string`
852
853 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1429 - `created_at: string`
1430
1431 format: date-time
8541432
8551433 - `period: BetaSpendLimitPeriod`
8561434
857 Period this row's effective limit and spend are reported for.
858
8591435 - `"daily"`
8601436
8611437 - `"monthly"`
8621438
8631439 - `"weekly"`
8641440
865 - `period_to_date_spend: string`
866
867 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.
868
869 - `scope: User or SeatTier or RBACGroup or 3 more`
870
871 - `User object`
872
873 Scope selecting a single member of the organization.
874
875 - `type: "user"`
876
877 Scope type. Always `user` for this scope.
878
879 default: user
880
881 - `user_id: string`
882
883 Tagged ID of the member the spend limit applies to.
884
885 - `SeatTier object`
886
887 - `type: "seat_tier"`
888
889 default: seat_tier
890
891 - `seat_tier: string`
892
893 - `RBACGroup object`
894
895 - `type: "rbac_group"`
896
897 default: rbac_group
898
899 - `rbac_group_id: string`
900
901 - `OrganizationService object`
902
903 - `type: "organization_service"`
904
905 default: organization_service
906
907 - `service: string`
908
909 - `Organization object`
910
911 - `type: "organization"`
912
913 default: organization
914
915 - `Workspace object`
916
917 Scope selecting one workspace of a Claude Console organization.
918
919 - `type: "workspace"`
920
921 Scope type. Always `workspace` for this scope.
922
923 default: workspace
924
925 - `workspace_id: string`
926
927 Tagged ID of the workspace the spend limit applies to.
928
929 - `source: User or SeatTier or RBACGroup or 3 more`
930
931 - `User object`
932
933 Scope selecting a single member of the organization.
934
935 - `type: "user"`
936
937 Scope type. Always `user` for this scope.
938
939 default: user
940
941 - `user_id: string`
942
943 Tagged ID of the member the spend limit applies to.
944
945 - `SeatTier object`
946
947 - `type: "seat_tier"`
948
949 default: seat_tier
950
951 - `seat_tier: string`
952
953 - `RBACGroup object`
954
955 - `type: "rbac_group"`
956
957 default: rbac_group
958
959 - `rbac_group_id: string`
960
961 - `OrganizationService object`
962
963 - `type: "organization_service"`
964
965 default: organization_service
966
967 - `service: string`
968
969 - `Organization object`
970
971 - `type: "organization"`
972
973 default: organization
974
975 - `Workspace object`
976
977 Scope selecting one workspace of a Claude Console organization.
978
979 - `type: "workspace"`
980
981 Scope type. Always `workspace` for this scope.
982
983 default: workspace
984
985 - `workspace_id: string`
986
987 Tagged ID of the workspace the spend limit applies to.
988
989 - `spend_limit_id: string`
990
991### Spend Limit Delete Response
992
993- `SpendLimitDeleteResponse object`
994
995 - `type: "spend_limit_deleted"`
996
997 default: spend_limit_deleted
998
999 - `id: string`
1000
1001## Spend Limits › Increase Requests
1002
1003### List Spend Limit Increase Requests
1004
1005**GET** `/v1/organizations/spend_limit_increase_requests`
1006
1007List spend limit increase requests, most recent first.
1008
1009Pending requests include a live `spend_summary` for the requester.
1010Requests whose requester is no longer a member are excluded.
1011
1012#### Query parameters
1013
1014- `actor_ids: optional array of string`
1015
1016 Filter by requester, as `user_...` tagged IDs.
1017
1018- `limit: optional number`
1019
1020 default: 20, minimum: 1, maximum: 1000
1021
1022- `page: optional string`
1023
1024 Opaque cursor from a previous response's `next_page`.
1025
1026- `status: optional array of BetaSpendLimitIncreaseRequestStatus`
1027
1028 Filter by status. Omit to return all.
1029
1030 - `"approved"`
1031
1032 - `"denied"`
1033
1034 - `"pending"`
1035
1036#### Returns
1037
1038- `data: array of BetaSpendLimitIncreaseRequest`
1039
1040 - `type: "spend_limit_increase_request"`
1041
1042 default: spend_limit_increase_request
1043
1044 - `id: string`
1045
1046 - `actor: UserActor or ScopedAPIKeyActor`
1047
1048 - `UserActor object`
1441 - `resolved_at: string or null`
1442
1443 format: date-time
1444
1445 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
1446
1447 - `BetaSpendLimitUserActor object`
10491448
10501449 A user within the organization. `name` and `email_address` are
10511450 null when the underlying account is unavailable or has been deleted;
10521451 `deleted` is true only for deleted accounts.
10531452
1054 - `type: "user_actor"`
1055
1056 Actor type. Always `user_actor`.
1057
1058 default: user_actor
1059
1060 - `deleted: boolean`
1061
1062 True only when the underlying account has been deleted.
1063
1064 default: false
1065
1066 - `email_address: string or null`
1067
1068 The user's email address. Null when the account is unavailable or has been deleted.
1069
1070 - `name: string or null`
1071
1072 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1073
1074 - `user_id: string`
1075
1076 Tagged ID of the user.
1077
1078 - `ScopedAPIKeyActor object`
1453 - `BetaSpendLimitScopedAPIKeyActor object`
10791454
10801455 A scoped Admin API key acting on behalf of the organization.
10811456
1082 - `type: "scoped_api_key_actor"`
1083
1084 default: scoped_api_key_actor
1085
1086 - `scoped_api_key_id: string`
1087
1088 - `created_at: string`
1089
1090 format: date-time
1091
1092 - `period: BetaSpendLimitPeriod`
1093
1094 - `"daily"`
1095
1096 - `"monthly"`
1097
1098 - `"weekly"`
1099
1100 - `resolved_at: string or null`
1101
1102 format: date-time
1103
1104 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
1105
1106 - `UserActor object`
1107
1108 A user within the organization. `name` and `email_address` are
1109 null when the underlying account is unavailable or has been deleted;
1110 `deleted` is true only for deleted accounts.
1111
1112 - `type: "user_actor"`
1113
1114 Actor type. Always `user_actor`.
1115
1116 default: user_actor
1117
1118 - `deleted: boolean`
1119
1120 True only when the underlying account has been deleted.
1121
1122 default: false
1123
1124 - `email_address: string or null`
1125
1126 The user's email address. Null when the account is unavailable or has been deleted.
1127
1128 - `name: string or null`
1129
1130 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1131
1132 - `user_id: string`
1133
1134 Tagged ID of the user.
1135
1136 - `ScopedAPIKeyActor object`
1137
1138 A scoped Admin API key acting on behalf of the organization.
1139
1140 - `type: "scoped_api_key_actor"`
1141
1142 default: scoped_api_key_actor
1143
1144 - `scoped_api_key_id: string`
1145
11461457 - `spend_summary: BetaSpendSummary or null`
11471458
11481459 Per-member effective-limit report row (`GET /spend_limits/effective`).
11491460
1150 - `actor: UserActor or ScopedAPIKeyActor`
1151
1152 - `UserActor object`
1461 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1462
1463 - `BetaSpendLimitUserActor object`
11531464
11541465 A user within the organization. `name` and `email_address` are
11551466 null when the underlying account is unavailable or has been deleted;
11561467 `deleted` is true only for deleted accounts.
11571468
1158 - `type: "user_actor"`
1159
1160 Actor type. Always `user_actor`.
1161
1162 default: user_actor
1163
1164 - `deleted: boolean`
1165
1166 True only when the underlying account has been deleted.
1167
1168 default: false
1169
1170 - `email_address: string or null`
1171
1172 The user's email address. Null when the account is unavailable or has been deleted.
1173
1174 - `name: string or null`
1175
1176 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1469 - `BetaSpendLimitScopedAPIKeyActor object`
1470
1471 A scoped Admin API key acting on behalf of the organization.
1472
1473 - `amount: string or null`
1474
1475 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.
1476
1477 - `currency: string`
1478
1479 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1480
1481 - `period: BetaSpendLimitPeriod`
1482
1483 Period this row's effective limit and spend are reported for.
1484
1485 - `period_to_date_spend: string`
1486
1487 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.
1488
1489 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1490
1491 - `BetaSpendLimitUserScope object`
1492
1493 Scope selecting a single member of the organization.
1494
1495 - `type: "user"`
1496
1497 Scope type. Always `user` for this scope.
1498
1499 default: user
11771500
11781501 - `user_id: string`
11791502
1180 Tagged ID of the user.
1181
1182 - `ScopedAPIKeyActor object`
1183
1184 A scoped Admin API key acting on behalf of the organization.
1185
1186 - `type: "scoped_api_key_actor"`
1187
1188 default: scoped_api_key_actor
1189
1190 - `scoped_api_key_id: string`
1191
1192 - `amount: string or null`
1193
1194 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.
1195
1196 - `currency: string`
1197
1198 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1199
1200 - `period: BetaSpendLimitPeriod`
1201
1202 Period this row's effective limit and spend are reported for.
1203
1204 - `period_to_date_spend: string`
1205
1206 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.
1207
1208 - `scope: User or SeatTier or RBACGroup or 3 more`
1209
1210 - `User object`
1503 Tagged ID of the member the spend limit applies to.
1504
1505 - `BetaSpendLimitSeatTierScope object`
1506
1507 - `type: "seat_tier"`
1508
1509 default: seat_tier
1510
1511 - `seat_tier: string`
1512
1513 - `BetaSpendLimitRBACGroupScope object`
1514
1515 - `type: "rbac_group"`
1516
1517 default: rbac_group
1518
1519 - `rbac_group_id: string`
1520
1521 - `BetaSpendLimitOrganizationServiceScope object`
1522
1523 - `type: "organization_service"`
1524
1525 default: organization_service
1526
1527 - `service: string`
1528
1529 - `BetaSpendLimitOrganizationScope object`
1530
1531 - `type: "organization"`
1532
1533 default: organization
1534
1535 - `BetaSpendLimitWorkspaceScope object`
1536
1537 Scope selecting one workspace of a Claude Console organization.
1538
1539 - `type: "workspace"`
1540
1541 Scope type. Always `workspace` for this scope.
1542
1543 default: workspace
1544
1545 - `workspace_id: string`
1546
1547 Tagged ID of the workspace the spend limit applies to.
1548
1549 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1550
1551 - `BetaSpendLimitUserScope object`
12111552
12121553 Scope selecting a single member of the organization.
12131554
1214 - `type: "user"`
1215
1216 Scope type. Always `user` for this scope.
1217
1218 default: user
1219
1220 - `user_id: string`
1221
1222 Tagged ID of the member the spend limit applies to.
1223
1224 - `SeatTier object`
1225
1226 - `type: "seat_tier"`
1227
1228 default: seat_tier
1229
1230 - `seat_tier: string`
1231
1232 - `RBACGroup object`
1233
1234 - `type: "rbac_group"`
1235
1236 default: rbac_group
1237
1238 - `rbac_group_id: string`
1239
1240 - `OrganizationService object`
1241
1242 - `type: "organization_service"`
1243
1244 default: organization_service
1245
1246 - `service: string`
1247
1248 - `Organization object`
1249
1250 - `type: "organization"`
1251
1252 default: organization
1253
1254 - `Workspace object`
1555 - `BetaSpendLimitSeatTierScope object`
1556
1557 - `BetaSpendLimitRBACGroupScope object`
1558
1559 - `BetaSpendLimitOrganizationServiceScope object`
1560
1561 - `BetaSpendLimitOrganizationScope object`
1562
1563 - `BetaSpendLimitWorkspaceScope object`
12551564
12561565 Scope selecting one workspace of a Claude Console organization.
1257
1258 - `type: "workspace"`
1259
1260 Scope type. Always `workspace` for this scope.
1261
1262 default: workspace
1263
1264 - `workspace_id: string`
1265
1266 Tagged ID of the workspace the spend limit applies to.
1267
1268 - `source: User or SeatTier or RBACGroup or 3 more`
1269
1270 - `User object`
1271
1272 Scope selecting a single member of the organization.
1273
1274 - `type: "user"`
1275
1276 Scope type. Always `user` for this scope.
1277
1278 default: user
1279
1280 - `user_id: string`
1281
1282 Tagged ID of the member the spend limit applies to.
1283
1284 - `SeatTier object`
1285
1286 - `type: "seat_tier"`
1287
1288 default: seat_tier
1289
1290 - `seat_tier: string`
1291
1292 - `RBACGroup object`
1293
1294 - `type: "rbac_group"`
1295
1296 default: rbac_group
1297
1298 - `rbac_group_id: string`
1299
1300 - `OrganizationService object`
1301
1302 - `type: "organization_service"`
1303
1304 default: organization_service
1305
1306 - `service: string`
1307
1308 - `Organization object`
1309
1310 - `type: "organization"`
1311
1312 default: organization
1313
1314 - `Workspace object`
1315
1316 Scope selecting one workspace of a Claude Console organization.
1317
1318 - `type: "workspace"`
1319
1320 Scope type. Always `workspace` for this scope.
1321
1322 default: workspace
1323
1324 - `workspace_id: string`
1325
1326 Tagged ID of the workspace the spend limit applies to.
13271566
13281567 - `spend_limit_id: string`
13291568
from line 1663
14241663
14251664 - `id: string`
14261665
1427 - `actor: UserActor or ScopedAPIKeyActor`
1428
1429 - `UserActor object`
1666 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1667
1668 - `BetaSpendLimitUserActor object`
14301669
14311670 A user within the organization. `name` and `email_address` are
14321671 null when the underlying account is unavailable or has been deleted;
from line 1695
14561695
14571696 Tagged ID of the user.
14581697
1459 - `ScopedAPIKeyActor object`
1698 - `BetaSpendLimitScopedAPIKeyActor object`
14601699
14611700 A scoped Admin API key acting on behalf of the organization.
14621701
from line 1721
14821721
14831722 format: date-time
14841723
1485 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
1486
1487 - `UserActor object`
1724 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
1725
1726 - `BetaSpendLimitUserActor object`
14881727
14891728 A user within the organization. `name` and `email_address` are
14901729 null when the underlying account is unavailable or has been deleted;
14911730 `deleted` is true only for deleted accounts.
14921731
1493 - `type: "user_actor"`
1494
1495 Actor type. Always `user_actor`.
1496
1497 default: user_actor
1498
1499 - `deleted: boolean`
1500
1501 True only when the underlying account has been deleted.
1502
1503 default: false
1504
1505 - `email_address: string or null`
1506
1507 The user's email address. Null when the account is unavailable or has been deleted.
1508
1509 - `name: string or null`
1510
1511 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1512
1513 - `user_id: string`
1514
1515 Tagged ID of the user.
1516
1517 - `ScopedAPIKeyActor object`
1732 - `BetaSpendLimitScopedAPIKeyActor object`
15181733
15191734 A scoped Admin API key acting on behalf of the organization.
15201735
1521 - `type: "scoped_api_key_actor"`
1522
1523 default: scoped_api_key_actor
1524
1525 - `scoped_api_key_id: string`
1526
15271736 - `spend_summary: BetaSpendSummary or null`
15281737
15291738 Per-member effective-limit report row (`GET /spend_limits/effective`).
15301739
1531 - `actor: UserActor or ScopedAPIKeyActor`
1532
1533 - `UserActor object`
1740 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1741
1742 - `BetaSpendLimitUserActor object`
15341743
15351744 A user within the organization. `name` and `email_address` are
15361745 null when the underlying account is unavailable or has been deleted;
15371746 `deleted` is true only for deleted accounts.
15381747
1539 - `type: "user_actor"`
1540
1541 Actor type. Always `user_actor`.
1542
1543 default: user_actor
1544
1545 - `deleted: boolean`
1546
1547 True only when the underlying account has been deleted.
1548
1549 default: false
1550
1551 - `email_address: string or null`
1552
1553 The user's email address. Null when the account is unavailable or has been deleted.
1554
1555 - `name: string or null`
1556
1557 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1748 - `BetaSpendLimitScopedAPIKeyActor object`
1749
1750 A scoped Admin API key acting on behalf of the organization.
1751
1752 - `amount: string or null`
1753
1754 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.
1755
1756 - `currency: string`
1757
1758 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1759
1760 - `period: BetaSpendLimitPeriod`
1761
1762 Period this row's effective limit and spend are reported for.
1763
1764 - `period_to_date_spend: string`
1765
1766 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.
1767
1768 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1769
1770 - `BetaSpendLimitUserScope object`
1771
1772 Scope selecting a single member of the organization.
1773
1774 - `type: "user"`
1775
1776 Scope type. Always `user` for this scope.
1777
1778 default: user
15581779
15591780 - `user_id: string`
15601781
1561 Tagged ID of the user.
1562
1563 - `ScopedAPIKeyActor object`
1564
1565 A scoped Admin API key acting on behalf of the organization.
1566
1567 - `type: "scoped_api_key_actor"`
1568
1569 default: scoped_api_key_actor
1570
1571 - `scoped_api_key_id: string`
1572
1573 - `amount: string or null`
1574
1575 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.
1576
1577 - `currency: string`
1578
1579 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1580
1581 - `period: BetaSpendLimitPeriod`
1582
1583 Period this row's effective limit and spend are reported for.
1584
1585 - `period_to_date_spend: string`
1586
1587 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.
1588
1589 - `scope: User or SeatTier or RBACGroup or 3 more`
1590
1591 - `User object`
1782 Tagged ID of the member the spend limit applies to.
1783
1784 - `BetaSpendLimitSeatTierScope object`
1785
1786 - `type: "seat_tier"`
1787
1788 default: seat_tier
1789
1790 - `seat_tier: string`
1791
1792 - `BetaSpendLimitRBACGroupScope object`
1793
1794 - `type: "rbac_group"`
1795
1796 default: rbac_group
1797
1798 - `rbac_group_id: string`
1799
1800 - `BetaSpendLimitOrganizationServiceScope object`
1801
1802 - `type: "organization_service"`
1803
1804 default: organization_service
1805
1806 - `service: string`
1807
1808 - `BetaSpendLimitOrganizationScope object`
1809
1810 - `type: "organization"`
1811
1812 default: organization
1813
1814 - `BetaSpendLimitWorkspaceScope object`
1815
1816 Scope selecting one workspace of a Claude Console organization.
1817
1818 - `type: "workspace"`
1819
1820 Scope type. Always `workspace` for this scope.
1821
1822 default: workspace
1823
1824 - `workspace_id: string`
1825
1826 Tagged ID of the workspace the spend limit applies to.
1827
1828 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1829
1830 - `BetaSpendLimitUserScope object`
15921831
15931832 Scope selecting a single member of the organization.
15941833
1595 - `type: "user"`
1596
1597 Scope type. Always `user` for this scope.
1598
1599 default: user
1600
1601 - `user_id: string`
1602
1603 Tagged ID of the member the spend limit applies to.
1604
1605 - `SeatTier object`
1606
1607 - `type: "seat_tier"`
1608
1609 default: seat_tier
1610
1611 - `seat_tier: string`
1612
1613 - `RBACGroup object`
1614
1615 - `type: "rbac_group"`
1616
1617 default: rbac_group
1618
1619 - `rbac_group_id: string`
1620
1621 - `OrganizationService object`
1622
1623 - `type: "organization_service"`
1624
1625 default: organization_service
1626
1627 - `service: string`
1628
1629 - `Organization object`
1630
1631 - `type: "organization"`
1632
1633 default: organization
1634
1635 - `Workspace object`
1834 - `BetaSpendLimitSeatTierScope object`
1835
1836 - `BetaSpendLimitRBACGroupScope object`
1837
1838 - `BetaSpendLimitOrganizationServiceScope object`
1839
1840 - `BetaSpendLimitOrganizationScope object`
1841
1842 - `BetaSpendLimitWorkspaceScope object`
16361843
16371844 Scope selecting one workspace of a Claude Console organization.
1638
1639 - `type: "workspace"`
1640
1641 Scope type. Always `workspace` for this scope.
1642
1643 default: workspace
1644
1645 - `workspace_id: string`
1646
1647 Tagged ID of the workspace the spend limit applies to.
1648
1649 - `source: User or SeatTier or RBACGroup or 3 more`
1650
1651 - `User object`
1652
1653 Scope selecting a single member of the organization.
1654
1655 - `type: "user"`
1656
1657 Scope type. Always `user` for this scope.
1658
1659 default: user
1660
1661 - `user_id: string`
1662
1663 Tagged ID of the member the spend limit applies to.
1664
1665 - `SeatTier object`
1666
1667 - `type: "seat_tier"`
1668
1669 default: seat_tier
1670
1671 - `seat_tier: string`
1672
1673 - `RBACGroup object`
1674
1675 - `type: "rbac_group"`
1676
1677 default: rbac_group
1678
1679 - `rbac_group_id: string`
1680
1681 - `OrganizationService object`
1682
1683 - `type: "organization_service"`
1684
1685 default: organization_service
1686
1687 - `service: string`
1688
1689 - `Organization object`
1690
1691 - `type: "organization"`
1692
1693 default: organization
1694
1695 - `Workspace object`
1696
1697 Scope selecting one workspace of a Claude Console organization.
1698
1699 - `type: "workspace"`
1700
1701 Scope type. Always `workspace` for this scope.
1702
1703 default: workspace
1704
1705 - `workspace_id: string`
1706
1707 Tagged ID of the workspace the spend limit applies to.
17081845
17091846 - `spend_limit_id: string`
17101847
from line 1951
18141951
18151952- `id: string`
18161953
1817- `actor: UserActor or ScopedAPIKeyActor`
1818
1819 - `UserActor object`
1954- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1955
1956 - `BetaSpendLimitUserActor object`
18201957
18211958 A user within the organization. `name` and `email_address` are
18221959 null when the underlying account is unavailable or has been deleted;
from line 1983
18461983
18471984 Tagged ID of the user.
18481985
1849 - `ScopedAPIKeyActor object`
1986 - `BetaSpendLimitScopedAPIKeyActor object`
18501987
18511988 A scoped Admin API key acting on behalf of the organization.
18521989
from line 2009
18722009
18732010 format: date-time
18742011
1875- `resolved_by: UserActor or ScopedAPIKeyActor or null`
1876
1877 - `UserActor object`
2012- `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
2013
2014 - `BetaSpendLimitUserActor object`
18782015
18792016 A user within the organization. `name` and `email_address` are
18802017 null when the underlying account is unavailable or has been deleted;
18812018 `deleted` is true only for deleted accounts.
18822019
1883 - `type: "user_actor"`
1884
1885 Actor type. Always `user_actor`.
1886
1887 default: user_actor
1888
1889 - `deleted: boolean`
1890
1891 True only when the underlying account has been deleted.
1892
1893 default: false
1894
1895 - `email_address: string or null`
1896
1897 The user's email address. Null when the account is unavailable or has been deleted.
1898
1899 - `name: string or null`
1900
1901 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1902
1903 - `user_id: string`
1904
1905 Tagged ID of the user.
1906
1907 - `ScopedAPIKeyActor object`
2020 - `BetaSpendLimitScopedAPIKeyActor object`
19082021
19092022 A scoped Admin API key acting on behalf of the organization.
19102023
1911 - `type: "scoped_api_key_actor"`
1912
1913 default: scoped_api_key_actor
1914
1915 - `scoped_api_key_id: string`
1916
19172024- `spend_limit: BetaSpendLimit`
19182025
19192026 A configured spend limit: a cap on metered spend for one scope and period.
from line 2049
19422049
19432050 ISO 4217 code of the organization's billing currency; the unit for `amount`.
19442051
2052 - `is_enabled: boolean`
2053
2054 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.
2055
19452056 - `period: BetaSpendLimitPeriod`
19462057
19472058 Length of the window the limit resets over. `amount` caps spend within each period.
19482059
1949 - `scope: User or SeatTier or RBACGroup or 3 more`
2060 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
19502061
19512062 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
19522063
1953 - `User object`
2064 - `BetaSpendLimitUserScope object`
19542065
19552066 Scope selecting a single member of the organization.
19562067
from line 2075
19642075
19652076 Tagged ID of the member the spend limit applies to.
19662077
1967 - `SeatTier object`
2078 - `BetaSpendLimitSeatTierScope object`
19682079
19692080 - `type: "seat_tier"`
19702081
from line 2083
19722083
19732084 - `seat_tier: string`
19742085
1975 - `RBACGroup object`
2086 - `BetaSpendLimitRBACGroupScope object`
19762087
19772088 - `type: "rbac_group"`
19782089
from line 2091
19802091
19812092 - `rbac_group_id: string`
19822093
1983 - `OrganizationService object`
2094 - `BetaSpendLimitOrganizationServiceScope object`
19842095
19852096 - `type: "organization_service"`
19862097
from line 2099
19882099
19892100 - `service: string`
19902101
1991 - `Organization object`
2102 - `BetaSpendLimitOrganizationScope object`
19922103
19932104 - `type: "organization"`
19942105
19952106 default: organization
19962107
1997 - `Workspace object`
2108 - `BetaSpendLimitWorkspaceScope object`
19982109
19992110 Scope selecting one workspace of a Claude Console organization.
20002111
from line 2129
20182129
20192130 Per-member effective-limit report row (`GET /spend_limits/effective`).
20202131
2021 - `actor: UserActor or ScopedAPIKeyActor`
2022
2023 - `UserActor object`
2132 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
2133
2134 - `BetaSpendLimitUserActor object`
20242135
20252136 A user within the organization. `name` and `email_address` are
20262137 null when the underlying account is unavailable or has been deleted;
20272138 `deleted` is true only for deleted accounts.
20282139
2029 - `type: "user_actor"`
2030
2031 Actor type. Always `user_actor`.
2032
2033 default: user_actor
2034
2035 - `deleted: boolean`
2036
2037 True only when the underlying account has been deleted.
2038
2039 default: false
2040
2041 - `email_address: string or null`
2042
2043 The user's email address. Null when the account is unavailable or has been deleted.
2044
2045 - `name: string or null`
2046
2047 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2048
2049 - `user_id: string`
2050
2051 Tagged ID of the user.
2052
2053 - `ScopedAPIKeyActor object`
2140 - `BetaSpendLimitScopedAPIKeyActor object`
20542141
20552142 A scoped Admin API key acting on behalf of the organization.
20562143
2057 - `type: "scoped_api_key_actor"`
2058
2059 default: scoped_api_key_actor
2060
2061 - `scoped_api_key_id: string`
2062
20632144 - `amount: string or null`
20642145
20652146 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.
from line 2157
20762157
20772158 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.
20782159
2079 - `scope: User or SeatTier or RBACGroup or 3 more`
2080
2081 - `User object`
2160 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
2161
2162 - `BetaSpendLimitUserScope object`
20822163
20832164 Scope selecting a single member of the organization.
20842165
2085 - `type: "user"`
2086
2087 Scope type. Always `user` for this scope.
2088
2089 default: user
2090
2091 - `user_id: string`
2092
2093 Tagged ID of the member the spend limit applies to.
2094
2095 - `SeatTier object`
2096
2097 - `type: "seat_tier"`
2098
2099 default: seat_tier
2100
2101 - `seat_tier: string`
2102
2103 - `RBACGroup object`
2104
2105 - `type: "rbac_group"`
2106
2107 default: rbac_group
2108
2109 - `rbac_group_id: string`
2110
2111 - `OrganizationService object`
2112
2113 - `type: "organization_service"`
2114
2115 default: organization_service
2116
2117 - `service: string`
2118
2119 - `Organization object`
2120
2121 - `type: "organization"`
2122
2123 default: organization
2124
2125 - `Workspace object`
2166 - `BetaSpendLimitSeatTierScope object`
2167
2168 - `BetaSpendLimitRBACGroupScope object`
2169
2170 - `BetaSpendLimitOrganizationServiceScope object`
2171
2172 - `BetaSpendLimitOrganizationScope object`
2173
2174 - `BetaSpendLimitWorkspaceScope object`
21262175
21272176 Scope selecting one workspace of a Claude Console organization.
21282177
2129 - `type: "workspace"`
2130
2131 Scope type. Always `workspace` for this scope.
2132
2133 default: workspace
2134
2135 - `workspace_id: string`
2136
2137 Tagged ID of the workspace the spend limit applies to.
2138
2139 - `source: User or SeatTier or RBACGroup or 3 more`
2140
2141 - `User object`
2178 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
2179
2180 - `BetaSpendLimitUserScope object`
21422181
21432182 Scope selecting a single member of the organization.
21442183
2145 - `type: "user"`
2146
2147 Scope type. Always `user` for this scope.
2148
2149 default: user
2150
2151 - `user_id: string`
2152
2153 Tagged ID of the member the spend limit applies to.
2154
2155 - `SeatTier object`
2156
2157 - `type: "seat_tier"`
2158
2159 default: seat_tier
2160
2161 - `seat_tier: string`
2162
2163 - `RBACGroup object`
2164
2165 - `type: "rbac_group"`
2166
2167 default: rbac_group
2168
2169 - `rbac_group_id: string`
2170
2171 - `OrganizationService object`
2172
2173 - `type: "organization_service"`
2174
2175 default: organization_service
2176
2177 - `service: string`
2178
2179 - `Organization object`
2180
2181 - `type: "organization"`
2182
2183 default: organization
2184
2185 - `Workspace object`
2184 - `BetaSpendLimitSeatTierScope object`
2185
2186 - `BetaSpendLimitRBACGroupScope object`
2187
2188 - `BetaSpendLimitOrganizationServiceScope object`
2189
2190 - `BetaSpendLimitOrganizationScope object`
2191
2192 - `BetaSpendLimitWorkspaceScope object`
21862193
21872194 Scope selecting one workspace of a Claude Console organization.
2188
2189 - `type: "workspace"`
2190
2191 Scope type. Always `workspace` for this scope.
2192
2193 default: workspace
2194
2195 - `workspace_id: string`
2196
2197 Tagged ID of the workspace the spend limit applies to.
21982195
21992196 - `spend_limit_id: string`
22002197
from line 2243
22462243 "amount": "50000",
22472244 "created_at": "2019-12-27T18:11:19.117Z",
22482245 "currency": "USD",
2246 "is_enabled": true,
22492247 "period": "daily",
22502248 "scope": {
22512249 "type": "user",
from line 2308
23102308
23112309 - `id: string`
23122310
2313 - `actor: UserActor or ScopedAPIKeyActor`
2314
2315 - `UserActor object`
2311 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
2312
2313 - `BetaSpendLimitUserActor object`
23162314
23172315 A user within the organization. `name` and `email_address` are
23182316 null when the underlying account is unavailable or has been deleted;
from line 2340
23422340
23432341 Tagged ID of the user.
23442342
2345 - `ScopedAPIKeyActor object`
2343 - `BetaSpendLimitScopedAPIKeyActor object`
23462344
23472345 A scoped Admin API key acting on behalf of the organization.
23482346
from line 2366
23682366
23692367 format: date-time
23702368
2371 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
2372
2373 - `UserActor object`
2369 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
2370
2371 - `BetaSpendLimitUserActor object`
23742372
23752373 A user within the organization. `name` and `email_address` are
23762374 null when the underlying account is unavailable or has been deleted;
23772375 `deleted` is true only for deleted accounts.
23782376
2379 - `type: "user_actor"`
2380
2381 Actor type. Always `user_actor`.
2382
2383 default: user_actor
2384
2385 - `deleted: boolean`
2386
2387 True only when the underlying account has been deleted.
2388
2389 default: false
2390
2391 - `email_address: string or null`
2392
2393 The user's email address. Null when the account is unavailable or has been deleted.
2394
2395 - `name: string or null`
2396
2397 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2398
2399 - `user_id: string`
2400
2401 Tagged ID of the user.
2402
2403 - `ScopedAPIKeyActor object`
2377 - `BetaSpendLimitScopedAPIKeyActor object`
24042378
24052379 A scoped Admin API key acting on behalf of the organization.
24062380
2407 - `type: "scoped_api_key_actor"`
2408
2409 default: scoped_api_key_actor
2410
2411 - `scoped_api_key_id: string`
2412
24132381 - `spend_summary: BetaSpendSummary or null`
24142382
24152383 Per-member effective-limit report row (`GET /spend_limits/effective`).
24162384
2417 - `actor: UserActor or ScopedAPIKeyActor`
2418
2419 - `UserActor object`
2385 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
2386
2387 - `BetaSpendLimitUserActor object`
24202388
24212389 A user within the organization. `name` and `email_address` are
24222390 null when the underlying account is unavailable or has been deleted;
24232391 `deleted` is true only for deleted accounts.
24242392
2425 - `type: "user_actor"`
2426
2427 Actor type. Always `user_actor`.
2428
2429 default: user_actor
2430
2431 - `deleted: boolean`
2432
2433 True only when the underlying account has been deleted.
2434
2435 default: false
2436
2437 - `email_address: string or null`
2438
2439 The user's email address. Null when the account is unavailable or has been deleted.
2440
2441 - `name: string or null`
2442
2443 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2393 - `BetaSpendLimitScopedAPIKeyActor object`
2394
2395 A scoped Admin API key acting on behalf of the organization.
2396
2397 - `amount: string or null`
2398
2399 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.
2400
2401 - `currency: string`
2402
2403 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
2404
2405 - `period: BetaSpendLimitPeriod`
2406
2407 Period this row's effective limit and spend are reported for.
2408
2409 - `period_to_date_spend: string`
2410
2411 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.
2412
2413 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
2414
2415 - `BetaSpendLimitUserScope object`
2416
2417 Scope selecting a single member of the organization.
2418
2419 - `type: "user"`
2420
2421 Scope type. Always `user` for this scope.
2422
2423 default: user
24442424
24452425 - `user_id: string`
24462426
2447 Tagged ID of the user.
2448
2449 - `ScopedAPIKeyActor object`
2450
2451 A scoped Admin API key acting on behalf of the organization.
2452
2453 - `type: "scoped_api_key_actor"`
2454
2455 default: scoped_api_key_actor
2456
2457 - `scoped_api_key_id: string`
2458
2459 - `amount: string or null`
2460
2461 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.
2462
2463 - `currency: string`
2464
2465 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
2466
2467 - `period: BetaSpendLimitPeriod`
2468
2469 Period this row's effective limit and spend are reported for.
2470
2471 - `period_to_date_spend: string`
2472
2473 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.
2474
2475 - `scope: User or SeatTier or RBACGroup or 3 more`
2476
2477 - `User object`
2427 Tagged ID of the member the spend limit applies to.
2428
2429 - `BetaSpendLimitSeatTierScope object`
2430
2431 - `type: "seat_tier"`
2432
2433 default: seat_tier
2434
2435 - `seat_tier: string`
2436
2437 - `BetaSpendLimitRBACGroupScope object`
2438
2439 - `type: "rbac_group"`
2440
2441 default: rbac_group
2442
2443 - `rbac_group_id: string`
2444
2445 - `BetaSpendLimitOrganizationServiceScope object`
2446
2447 - `type: "organization_service"`
2448
2449 default: organization_service
2450
2451 - `service: string`
2452
2453 - `BetaSpendLimitOrganizationScope object`
2454
2455 - `type: "organization"`
2456
2457 default: organization
2458
2459 - `BetaSpendLimitWorkspaceScope object`
2460
2461 Scope selecting one workspace of a Claude Console organization.
2462
2463 - `type: "workspace"`
2464
2465 Scope type. Always `workspace` for this scope.
2466
2467 default: workspace
2468
2469 - `workspace_id: string`
2470
2471 Tagged ID of the workspace the spend limit applies to.
2472
2473 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
2474
2475 - `BetaSpendLimitUserScope object`
24782476
24792477 Scope selecting a single member of the organization.
24802478
2481 - `type: "user"`
2482
2483 Scope type. Always `user` for this scope.
2484
2485 default: user
2486
2487 - `user_id: string`
2488
2489 Tagged ID of the member the spend limit applies to.
2490
2491 - `SeatTier object`
2492
2493 - `type: "seat_tier"`
2494
2495 default: seat_tier
2496
2497 - `seat_tier: string`
2498
2499 - `RBACGroup object`
2500
2501 - `type: "rbac_group"`
2502
2503 default: rbac_group
2504
2505 - `rbac_group_id: string`
2506
2507 - `OrganizationService object`
2508
2509 - `type: "organization_service"`
2510
2511 default: organization_service
2512
2513 - `service: string`
2514
2515 - `Organization object`
2516
2517 - `type: "organization"`
2518
2519 default: organization
2520
2521 - `Workspace object`
2479 - `BetaSpendLimitSeatTierScope object`
2480
2481 - `BetaSpendLimitRBACGroupScope object`
2482
2483 - `BetaSpendLimitOrganizationServiceScope object`
2484
2485 - `BetaSpendLimitOrganizationScope object`
2486
2487 - `BetaSpendLimitWorkspaceScope object`
25222488
25232489 Scope selecting one workspace of a Claude Console organization.
2524
2525 - `type: "workspace"`
2526
2527 Scope type. Always `workspace` for this scope.
2528
2529 default: workspace
2530
2531 - `workspace_id: string`
2532
2533 Tagged ID of the workspace the spend limit applies to.
2534
2535 - `source: User or SeatTier or RBACGroup or 3 more`
2536
2537 - `User object`
2538
2539 Scope selecting a single member of the organization.
2540
2541 - `type: "user"`
2542
2543 Scope type. Always `user` for this scope.
2544
2545 default: user
2546
2547 - `user_id: string`
2548
2549 Tagged ID of the member the spend limit applies to.
2550
2551 - `SeatTier object`
2552
2553 - `type: "seat_tier"`
2554
2555 default: seat_tier
2556
2557 - `seat_tier: string`
2558
2559 - `RBACGroup object`
2560
2561 - `type: "rbac_group"`
2562
2563 default: rbac_group
2564
2565 - `rbac_group_id: string`
2566
2567 - `OrganizationService object`
2568
2569 - `type: "organization_service"`
2570
2571 default: organization_service
2572
2573 - `service: string`
2574
2575 - `Organization object`
2576
2577 - `type: "organization"`
2578
2579 default: organization
2580
2581 - `Workspace object`
2582
2583 Scope selecting one workspace of a Claude Console organization.
2584
2585 - `type: "workspace"`
2586
2587 Scope type. Always `workspace` for this scope.
2588
2589 default: workspace
2590
2591 - `workspace_id: string`
2592
2593 Tagged ID of the workspace the spend limit applies to.
25942490
25952491 - `spend_limit_id: string`
25962492
25972493
api/beta/organization/spend_limits/create Page removed · 213 lines, page removed
# Set Spend Limit ## Body parameters ## Returns ## Example ### Response (200)
The page is gone upstream. What it last said is kept here.
api/beta/organization/spend_limits/effective New page · 236 lines, new page
# Effective ## List Effective Spend Limits ### Query parameters ### Returns ### Example #### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: Effective
url: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/effective
---
# Effective
## List Effective Spend Limits
**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.
### Query parameters
- `limit: optional number`
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`.
default: 20, minimum: 1, maximum: 1000
- `page: optional string`
Opaque cursor from a previous response's `next_page` field.
- `period: optional array of "daily" or "monthly" or "weekly"`
Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.
maxItems: 3
- `"daily"`
- `"monthly"`
- `"weekly"`
- `user_ids: optional array of string`
Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries.
maxItems: 100
### Returns
- `data: array of BetaSpendSummary`
- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
- `BetaSpendLimitUserActor object`
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`.
default: user_actor
- `deleted: boolean`
True only when the underlying account has been deleted.
default: false
- `email_address: string or null`
The user's email address. Null when the account is unavailable or has been deleted.
- `name: string or null`
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.
- `BetaSpendLimitScopedAPIKeyActor object`
A scoped Admin API key acting on behalf of the organization.
- `type: "scoped_api_key_actor"`
default: scoped_api_key_actor
- `scoped_api_key_id: string`
- `amount: string or null`
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: BetaSpendLimitPeriod`
Period this row's effective limit and spend are reported for.
- `"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 3 more`
- `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.
- `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
- `BetaSpendLimitUserScope object`
Scope selecting a single member of the organization.
- `BetaSpendLimitSeatTierScope object`
- `BetaSpendLimitRBACGroupScope object`
- `BetaSpendLimitOrganizationServiceScope object`
- `BetaSpendLimitOrganizationScope object`
- `BetaSpendLimitWorkspaceScope object`
Scope selecting one workspace of a Claude Console organization.
- `spend_limit_id: string`
- `next_page: string or null`
### Example
```bash
curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### 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"
}
```
api/beta/organization/spend_limits/effective/list New page · 234 lines, new page
# List Effective Spend Limits ## Query parameters ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List Effective Spend Limits
url: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/effective/list
---
# List Effective Spend Limits
**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.
## Query parameters
- `limit: optional number`
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`.
default: 20, minimum: 1, maximum: 1000
- `page: optional string`
Opaque cursor from a previous response's `next_page` field.
- `period: optional array of "daily" or "monthly" or "weekly"`
Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.
maxItems: 3
- `"daily"`
- `"monthly"`
- `"weekly"`
- `user_ids: optional array of string`
Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries.
maxItems: 100
## Returns
- `data: array of BetaSpendSummary`
- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
- `BetaSpendLimitUserActor object`
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`.
default: user_actor
- `deleted: boolean`
True only when the underlying account has been deleted.
default: false
- `email_address: string or null`
The user's email address. Null when the account is unavailable or has been deleted.
- `name: string or null`
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.
- `BetaSpendLimitScopedAPIKeyActor object`
A scoped Admin API key acting on behalf of the organization.
- `type: "scoped_api_key_actor"`
default: scoped_api_key_actor
- `scoped_api_key_id: string`
- `amount: string or null`
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: BetaSpendLimitPeriod`
Period this row's effective limit and spend are reported for.
- `"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 3 more`
- `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.
- `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
- `BetaSpendLimitUserScope object`
Scope selecting a single member of the organization.
- `BetaSpendLimitSeatTierScope object`
- `BetaSpendLimitRBACGroupScope object`
- `BetaSpendLimitOrganizationServiceScope object`
- `BetaSpendLimitOrganizationScope object`
- `BetaSpendLimitWorkspaceScope object`
Scope selecting one workspace of a Claude Console organization.
- `spend_limit_id: string`
- `next_page: string or null`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
-H 'anthropic-version: 2023-06-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### 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"
}
```
api/beta/organization/spend_limits/increase_requests Changed · +495 / -1182 lines
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 48
4848
4949 - `id: string`
5050
51 - `actor: UserActor or ScopedAPIKeyActor`
52
53 - `UserActor object`
51 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
52
53 - `BetaSpendLimitUserActor object`
5454
5555 A user within the organization. `name` and `email_address` are
5656 null when the underlying account is unavailable or has been deleted;
from line 80
8080
8181 Tagged ID of the user.
8282
83 - `ScopedAPIKeyActor object`
83 - `BetaSpendLimitScopedAPIKeyActor object`
8484
8585 A scoped Admin API key acting on behalf of the organization.
8686
from line 106
106106
107107 format: date-time
108108
109 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
110
111 - `UserActor object`
109 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
110
111 - `BetaSpendLimitUserActor object`
112112
113113 A user within the organization. `name` and `email_address` are
114114 null when the underlying account is unavailable or has been deleted;
115115 `deleted` is true only for deleted accounts.
116116
117 - `type: "user_actor"`
118
119 Actor type. Always `user_actor`.
120
121 default: user_actor
122
123 - `deleted: boolean`
124
125 True only when the underlying account has been deleted.
126
127 default: false
128
129 - `email_address: string or null`
130
131 The user's email address. Null when the account is unavailable or has been deleted.
132
133 - `name: string or null`
134
135 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
136
137 - `user_id: string`
138
139 Tagged ID of the user.
140
141 - `ScopedAPIKeyActor object`
117 - `BetaSpendLimitScopedAPIKeyActor object`
142118
143119 A scoped Admin API key acting on behalf of the organization.
144120
145 - `type: "scoped_api_key_actor"`
146
147 default: scoped_api_key_actor
148
149 - `scoped_api_key_id: string`
150
151121 - `spend_summary: BetaSpendSummary or null`
152122
153123 Per-member effective-limit report row (`GET /spend_limits/effective`).
154124
155 - `actor: UserActor or ScopedAPIKeyActor`
156
157 - `UserActor object`
125 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
126
127 - `BetaSpendLimitUserActor object`
158128
159129 A user within the organization. `name` and `email_address` are
160130 null when the underlying account is unavailable or has been deleted;
161131 `deleted` is true only for deleted accounts.
162132
163 - `type: "user_actor"`
164
165 Actor type. Always `user_actor`.
166
167 default: user_actor
168
169 - `deleted: boolean`
170
171 True only when the underlying account has been deleted.
172
173 default: false
174
175 - `email_address: string or null`
176
177 The user's email address. Null when the account is unavailable or has been deleted.
178
179 - `name: string or null`
180
181 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
133 - `BetaSpendLimitScopedAPIKeyActor object`
134
135 A scoped Admin API key acting on behalf of the organization.
136
137 - `amount: string or null`
138
139 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.
140
141 - `currency: string`
142
143 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
144
145 - `period: BetaSpendLimitPeriod`
146
147 Period this row's effective limit and spend are reported for.
148
149 - `period_to_date_spend: string`
150
151 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.
152
153 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
154
155 - `BetaSpendLimitUserScope object`
156
157 Scope selecting a single member of the organization.
158
159 - `type: "user"`
160
161 Scope type. Always `user` for this scope.
162
163 default: user
182164
183165 - `user_id: string`
184166
185 Tagged ID of the user.
186
187 - `ScopedAPIKeyActor object`
188
189 A scoped Admin API key acting on behalf of the organization.
190
191 - `type: "scoped_api_key_actor"`
192
193 default: scoped_api_key_actor
194
195 - `scoped_api_key_id: string`
196
197 - `amount: string or null`
198
199 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.
200
201 - `currency: string`
202
203 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
204
205 - `period: BetaSpendLimitPeriod`
206
207 Period this row's effective limit and spend are reported for.
208
209 - `period_to_date_spend: string`
210
211 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.
212
213 - `scope: User or SeatTier or RBACGroup or 3 more`
214
215 - `User object`
167 Tagged ID of the member the spend limit applies to.
168
169 - `BetaSpendLimitSeatTierScope object`
170
171 - `type: "seat_tier"`
172
173 default: seat_tier
174
175 - `seat_tier: string`
176
177 - `BetaSpendLimitRBACGroupScope object`
178
179 - `type: "rbac_group"`
180
181 default: rbac_group
182
183 - `rbac_group_id: string`
184
185 - `BetaSpendLimitOrganizationServiceScope object`
186
187 - `type: "organization_service"`
188
189 default: organization_service
190
191 - `service: string`
192
193 - `BetaSpendLimitOrganizationScope object`
194
195 - `type: "organization"`
196
197 default: organization
198
199 - `BetaSpendLimitWorkspaceScope object`
200
201 Scope selecting one workspace of a Claude Console organization.
202
203 - `type: "workspace"`
204
205 Scope type. Always `workspace` for this scope.
206
207 default: workspace
208
209 - `workspace_id: string`
210
211 Tagged ID of the workspace the spend limit applies to.
212
213 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
214
215 - `BetaSpendLimitUserScope object`
216216
217217 Scope selecting a single member of the organization.
218218
219 - `type: "user"`
220
221 Scope type. Always `user` for this scope.
222
223 default: user
224
225 - `user_id: string`
226
227 Tagged ID of the member the spend limit applies to.
228
229 - `SeatTier object`
230
231 - `type: "seat_tier"`
232
233 default: seat_tier
234
235 - `seat_tier: string`
236
237 - `RBACGroup object`
238
239 - `type: "rbac_group"`
240
241 default: rbac_group
242
243 - `rbac_group_id: string`
244
245 - `OrganizationService object`
246
247 - `type: "organization_service"`
248
249 default: organization_service
250
251 - `service: string`
252
253 - `Organization object`
254
255 - `type: "organization"`
256
257 default: organization
258
259 - `Workspace object`
219 - `BetaSpendLimitSeatTierScope object`
220
221 - `BetaSpendLimitRBACGroupScope object`
222
223 - `BetaSpendLimitOrganizationServiceScope object`
224
225 - `BetaSpendLimitOrganizationScope object`
226
227 - `BetaSpendLimitWorkspaceScope object`
260228
261229 Scope selecting one workspace of a Claude Console organization.
262
263 - `type: "workspace"`
264
265 Scope type. Always `workspace` for this scope.
266
267 default: workspace
268
269 - `workspace_id: string`
270
271 Tagged ID of the workspace the spend limit applies to.
272
273 - `source: User or SeatTier or RBACGroup or 3 more`
274
275 - `User object`
276
277 Scope selecting a single member of the organization.
278
279 - `type: "user"`
280
281 Scope type. Always `user` for this scope.
282
283 default: user
284
285 - `user_id: string`
286
287 Tagged ID of the member the spend limit applies to.
288
289 - `SeatTier object`
290
291 - `type: "seat_tier"`
292
293 default: seat_tier
294
295 - `seat_tier: string`
296
297 - `RBACGroup object`
298
299 - `type: "rbac_group"`
300
301 default: rbac_group
302
303 - `rbac_group_id: string`
304
305 - `OrganizationService object`
306
307 - `type: "organization_service"`
308
309 default: organization_service
310
311 - `service: string`
312
313 - `Organization object`
314
315 - `type: "organization"`
316
317 default: organization
318
319 - `Workspace object`
320
321 Scope selecting one workspace of a Claude Console organization.
322
323 - `type: "workspace"`
324
325 Scope type. Always `workspace` for this scope.
326
327 default: workspace
328
329 - `workspace_id: string`
330
331 Tagged ID of the workspace the spend limit applies to.
332230
333231 - `spend_limit_id: string`
334232
from line 327
429327
430328 - `id: string`
431329
432 - `actor: UserActor or ScopedAPIKeyActor`
433
434 - `UserActor object`
330 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
331
332 - `BetaSpendLimitUserActor object`
435333
436334 A user within the organization. `name` and `email_address` are
437335 null when the underlying account is unavailable or has been deleted;
from line 359
461359
462360 Tagged ID of the user.
463361
464 - `ScopedAPIKeyActor object`
362 - `BetaSpendLimitScopedAPIKeyActor object`
465363
466364 A scoped Admin API key acting on behalf of the organization.
467365
from line 385
487385
488386 format: date-time
489387
490 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
491
492 - `UserActor object`
388 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
389
390 - `BetaSpendLimitUserActor object`
493391
494392 A user within the organization. `name` and `email_address` are
495393 null when the underlying account is unavailable or has been deleted;
496394 `deleted` is true only for deleted accounts.
497395
498 - `type: "user_actor"`
499
500 Actor type. Always `user_actor`.
501
502 default: user_actor
503
504 - `deleted: boolean`
505
506 True only when the underlying account has been deleted.
507
508 default: false
509
510 - `email_address: string or null`
511
512 The user's email address. Null when the account is unavailable or has been deleted.
513
514 - `name: string or null`
515
516 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
517
518 - `user_id: string`
519
520 Tagged ID of the user.
521
522 - `ScopedAPIKeyActor object`
396 - `BetaSpendLimitScopedAPIKeyActor object`
523397
524398 A scoped Admin API key acting on behalf of the organization.
525399
526 - `type: "scoped_api_key_actor"`
527
528 default: scoped_api_key_actor
529
530 - `scoped_api_key_id: string`
531
532400 - `spend_summary: BetaSpendSummary or null`
533401
534402 Per-member effective-limit report row (`GET /spend_limits/effective`).
535403
536 - `actor: UserActor or ScopedAPIKeyActor`
537
538 - `UserActor object`
404 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
405
406 - `BetaSpendLimitUserActor object`
539407
540408 A user within the organization. `name` and `email_address` are
541409 null when the underlying account is unavailable or has been deleted;
542410 `deleted` is true only for deleted accounts.
543411
544 - `type: "user_actor"`
545
546 Actor type. Always `user_actor`.
547
548 default: user_actor
549
550 - `deleted: boolean`
551
552 True only when the underlying account has been deleted.
553
554 default: false
555
556 - `email_address: string or null`
557
558 The user's email address. Null when the account is unavailable or has been deleted.
559
560 - `name: string or null`
561
562 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
412 - `BetaSpendLimitScopedAPIKeyActor object`
413
414 A scoped Admin API key acting on behalf of the organization.
415
416 - `amount: string or null`
417
418 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.
419
420 - `currency: string`
421
422 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
423
424 - `period: BetaSpendLimitPeriod`
425
426 Period this row's effective limit and spend are reported for.
427
428 - `period_to_date_spend: string`
429
430 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.
431
432 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
433
434 - `BetaSpendLimitUserScope object`
435
436 Scope selecting a single member of the organization.
437
438 - `type: "user"`
439
440 Scope type. Always `user` for this scope.
441
442 default: user
563443
564444 - `user_id: string`
565445
566 Tagged ID of the user.
567
568 - `ScopedAPIKeyActor object`
569
570 A scoped Admin API key acting on behalf of the organization.
571
572 - `type: "scoped_api_key_actor"`
573
574 default: scoped_api_key_actor
575
576 - `scoped_api_key_id: string`
577
578 - `amount: string or null`
579
580 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.
581
582 - `currency: string`
583
584 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
585
586 - `period: BetaSpendLimitPeriod`
587
588 Period this row's effective limit and spend are reported for.
589
590 - `period_to_date_spend: string`
591
592 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.
593
594 - `scope: User or SeatTier or RBACGroup or 3 more`
595
596 - `User object`
446 Tagged ID of the member the spend limit applies to.
447
448 - `BetaSpendLimitSeatTierScope object`
449
450 - `type: "seat_tier"`
451
452 default: seat_tier
453
454 - `seat_tier: string`
455
456 - `BetaSpendLimitRBACGroupScope object`
457
458 - `type: "rbac_group"`
459
460 default: rbac_group
461
462 - `rbac_group_id: string`
463
464 - `BetaSpendLimitOrganizationServiceScope object`
465
466 - `type: "organization_service"`
467
468 default: organization_service
469
470 - `service: string`
471
472 - `BetaSpendLimitOrganizationScope object`
473
474 - `type: "organization"`
475
476 default: organization
477
478 - `BetaSpendLimitWorkspaceScope object`
479
480 Scope selecting one workspace of a Claude Console organization.
481
482 - `type: "workspace"`
483
484 Scope type. Always `workspace` for this scope.
485
486 default: workspace
487
488 - `workspace_id: string`
489
490 Tagged ID of the workspace the spend limit applies to.
491
492 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
493
494 - `BetaSpendLimitUserScope object`
597495
598496 Scope selecting a single member of the organization.
599497
600 - `type: "user"`
601
602 Scope type. Always `user` for this scope.
603
604 default: user
605
606 - `user_id: string`
607
608 Tagged ID of the member the spend limit applies to.
609
610 - `SeatTier object`
611
612 - `type: "seat_tier"`
613
614 default: seat_tier
615
616 - `seat_tier: string`
617
618 - `RBACGroup object`
619
620 - `type: "rbac_group"`
621
622 default: rbac_group
623
624 - `rbac_group_id: string`
625
626 - `OrganizationService object`
627
628 - `type: "organization_service"`
629
630 default: organization_service
631
632 - `service: string`
633
634 - `Organization object`
635
636 - `type: "organization"`
637
638 default: organization
639
640 - `Workspace object`
498 - `BetaSpendLimitSeatTierScope object`
499
500 - `BetaSpendLimitRBACGroupScope object`
501
502 - `BetaSpendLimitOrganizationServiceScope object`
503
504 - `BetaSpendLimitOrganizationScope object`
505
506 - `BetaSpendLimitWorkspaceScope object`
641507
642508 Scope selecting one workspace of a Claude Console organization.
643
644 - `type: "workspace"`
645
646 Scope type. Always `workspace` for this scope.
647
648 default: workspace
649
650 - `workspace_id: string`
651
652 Tagged ID of the workspace the spend limit applies to.
653
654 - `source: User or SeatTier or RBACGroup or 3 more`
655
656 - `User object`
657
658 Scope selecting a single member of the organization.
659
660 - `type: "user"`
661
662 Scope type. Always `user` for this scope.
663
664 default: user
665
666 - `user_id: string`
667
668 Tagged ID of the member the spend limit applies to.
669
670 - `SeatTier object`
671
672 - `type: "seat_tier"`
673
674 default: seat_tier
675
676 - `seat_tier: string`
677
678 - `RBACGroup object`
679
680 - `type: "rbac_group"`
681
682 default: rbac_group
683
684 - `rbac_group_id: string`
685
686 - `OrganizationService object`
687
688 - `type: "organization_service"`
689
690 default: organization_service
691
692 - `service: string`
693
694 - `Organization object`
695
696 - `type: "organization"`
697
698 default: organization
699
700 - `Workspace object`
701
702 Scope selecting one workspace of a Claude Console organization.
703
704 - `type: "workspace"`
705
706 Scope type. Always `workspace` for this scope.
707
708 default: workspace
709
710 - `workspace_id: string`
711
712 Tagged ID of the workspace the spend limit applies to.
713509
714510 - `spend_limit_id: string`
715511
from line 615
819615
820616- `id: string`
821617
822- `actor: UserActor or ScopedAPIKeyActor`
823
824 - `UserActor object`
618- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
619
620 - `BetaSpendLimitUserActor object`
825621
826622 A user within the organization. `name` and `email_address` are
827623 null when the underlying account is unavailable or has been deleted;
from line 647
851647
852648 Tagged ID of the user.
853649
854 - `ScopedAPIKeyActor object`
650 - `BetaSpendLimitScopedAPIKeyActor object`
855651
856652 A scoped Admin API key acting on behalf of the organization.
857653
from line 673
877673
878674 format: date-time
879675
880- `resolved_by: UserActor or ScopedAPIKeyActor or null`
881
882 - `UserActor object`
676- `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
677
678 - `BetaSpendLimitUserActor object`
883679
884680 A user within the organization. `name` and `email_address` are
885681 null when the underlying account is unavailable or has been deleted;
886682 `deleted` is true only for deleted accounts.
887683
888 - `type: "user_actor"`
889
890 Actor type. Always `user_actor`.
891
892 default: user_actor
893
894 - `deleted: boolean`
895
896 True only when the underlying account has been deleted.
897
898 default: false
899
900 - `email_address: string or null`
901
902 The user's email address. Null when the account is unavailable or has been deleted.
903
904 - `name: string or null`
905
906 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
907
908 - `user_id: string`
909
910 Tagged ID of the user.
911
912 - `ScopedAPIKeyActor object`
684 - `BetaSpendLimitScopedAPIKeyActor object`
913685
914686 A scoped Admin API key acting on behalf of the organization.
915687
916 - `type: "scoped_api_key_actor"`
917
918 default: scoped_api_key_actor
919
920 - `scoped_api_key_id: string`
921
922688- `spend_limit: BetaSpendLimit`
923689
924690 A configured spend limit: a cap on metered spend for one scope and period.
from line 713
947713
948714 ISO 4217 code of the organization's billing currency; the unit for `amount`.
949715
716 - `is_enabled: boolean`
717
718 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.
719
950720 - `period: BetaSpendLimitPeriod`
951721
952722 Length of the window the limit resets over. `amount` caps spend within each period.
953723
954 - `scope: User or SeatTier or RBACGroup or 3 more`
724 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
955725
956726 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
957727
958 - `User object`
728 - `BetaSpendLimitUserScope object`
959729
960730 Scope selecting a single member of the organization.
961731
from line 739
969739
970740 Tagged ID of the member the spend limit applies to.
971741
972 - `SeatTier object`
742 - `BetaSpendLimitSeatTierScope object`
973743
974744 - `type: "seat_tier"`
975745
from line 747
977747
978748 - `seat_tier: string`
979749
980 - `RBACGroup object`
750 - `BetaSpendLimitRBACGroupScope object`
981751
982752 - `type: "rbac_group"`
983753
from line 755
985755
986756 - `rbac_group_id: string`
987757
988 - `OrganizationService object`
758 - `BetaSpendLimitOrganizationServiceScope object`
989759
990760 - `type: "organization_service"`
991761
from line 763
993763
994764 - `service: string`
995765
996 - `Organization object`
766 - `BetaSpendLimitOrganizationScope object`
997767
998768 - `type: "organization"`
999769
1000770 default: organization
1001771
1002 - `Workspace object`
772 - `BetaSpendLimitWorkspaceScope object`
1003773
1004774 Scope selecting one workspace of a Claude Console organization.
1005775
from line 793
1023793
1024794 Per-member effective-limit report row (`GET /spend_limits/effective`).
1025795
1026 - `actor: UserActor or ScopedAPIKeyActor`
1027
1028 - `UserActor object`
796 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
797
798 - `BetaSpendLimitUserActor object`
1029799
1030800 A user within the organization. `name` and `email_address` are
1031801 null when the underlying account is unavailable or has been deleted;
1032802 `deleted` is true only for deleted accounts.
1033803
1034 - `type: "user_actor"`
1035
1036 Actor type. Always `user_actor`.
1037
1038 default: user_actor
1039
1040 - `deleted: boolean`
1041
1042 True only when the underlying account has been deleted.
1043
1044 default: false
1045
1046 - `email_address: string or null`
1047
1048 The user's email address. Null when the account is unavailable or has been deleted.
1049
1050 - `name: string or null`
1051
1052 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1053
1054 - `user_id: string`
1055
1056 Tagged ID of the user.
1057
1058 - `ScopedAPIKeyActor object`
804 - `BetaSpendLimitScopedAPIKeyActor object`
1059805
1060806 A scoped Admin API key acting on behalf of the organization.
1061807
1062 - `type: "scoped_api_key_actor"`
1063
1064 default: scoped_api_key_actor
1065
1066 - `scoped_api_key_id: string`
1067
1068808 - `amount: string or null`
1069809
1070810 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.
from line 821
1081821
1082822 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.
1083823
1084 - `scope: User or SeatTier or RBACGroup or 3 more`
1085
1086 - `User object`
824 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
825
826 - `BetaSpendLimitUserScope object`
1087827
1088828 Scope selecting a single member of the organization.
1089829
1090 - `type: "user"`
1091
1092 Scope type. Always `user` for this scope.
1093
1094 default: user
1095
1096 - `user_id: string`
1097
1098 Tagged ID of the member the spend limit applies to.
1099
1100 - `SeatTier object`
1101
1102 - `type: "seat_tier"`
1103
1104 default: seat_tier
1105
1106 - `seat_tier: string`
1107
1108 - `RBACGroup object`
1109
1110 - `type: "rbac_group"`
1111
1112 default: rbac_group
1113
1114 - `rbac_group_id: string`
1115
1116 - `OrganizationService object`
1117
1118 - `type: "organization_service"`
1119
1120 default: organization_service
1121
1122 - `service: string`
1123
1124 - `Organization object`
1125
1126 - `type: "organization"`
1127
1128 default: organization
1129
1130 - `Workspace object`
830 - `BetaSpendLimitSeatTierScope object`
831
832 - `BetaSpendLimitRBACGroupScope object`
833
834 - `BetaSpendLimitOrganizationServiceScope object`
835
836 - `BetaSpendLimitOrganizationScope object`
837
838 - `BetaSpendLimitWorkspaceScope object`
1131839
1132840 Scope selecting one workspace of a Claude Console organization.
1133841
1134 - `type: "workspace"`
1135
1136 Scope type. Always `workspace` for this scope.
1137
1138 default: workspace
1139
1140 - `workspace_id: string`
1141
1142 Tagged ID of the workspace the spend limit applies to.
1143
1144 - `source: User or SeatTier or RBACGroup or 3 more`
1145
1146 - `User object`
842 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
843
844 - `BetaSpendLimitUserScope object`
1147845
1148846 Scope selecting a single member of the organization.
1149847
1150 - `type: "user"`
1151
1152 Scope type. Always `user` for this scope.
1153
1154 default: user
1155
1156 - `user_id: string`
1157
1158 Tagged ID of the member the spend limit applies to.
1159
1160 - `SeatTier object`
1161
1162 - `type: "seat_tier"`
1163
1164 default: seat_tier
1165
1166 - `seat_tier: string`
1167
1168 - `RBACGroup object`
1169
1170 - `type: "rbac_group"`
1171
1172 default: rbac_group
1173
1174 - `rbac_group_id: string`
1175
1176 - `OrganizationService object`
1177
1178 - `type: "organization_service"`
1179
1180 default: organization_service
1181
1182 - `service: string`
1183
1184 - `Organization object`
1185
1186 - `type: "organization"`
1187
1188 default: organization
1189
1190 - `Workspace object`
848 - `BetaSpendLimitSeatTierScope object`
849
850 - `BetaSpendLimitRBACGroupScope object`
851
852 - `BetaSpendLimitOrganizationServiceScope object`
853
854 - `BetaSpendLimitOrganizationScope object`
855
856 - `BetaSpendLimitWorkspaceScope object`
1191857
1192858 Scope selecting one workspace of a Claude Console organization.
1193
1194 - `type: "workspace"`
1195
1196 Scope type. Always `workspace` for this scope.
1197
1198 default: workspace
1199
1200 - `workspace_id: string`
1201
1202 Tagged ID of the workspace the spend limit applies to.
1203859
1204860 - `spend_limit_id: string`
1205861
from line 907
1251907 "amount": "50000",
1252908 "created_at": "2019-12-27T18:11:19.117Z",
1253909 "currency": "USD",
910 "is_enabled": true,
1254911 "period": "daily",
1255912 "scope": {
1256913 "type": "user",
from line 972
1315972
1316973 - `id: string`
1317974
1318 - `actor: UserActor or ScopedAPIKeyActor`
1319
1320 - `UserActor object`
975 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
976
977 - `BetaSpendLimitUserActor object`
1321978
1322979 A user within the organization. `name` and `email_address` are
1323980 null when the underlying account is unavailable or has been deleted;
from line 1004
13471004
13481005 Tagged ID of the user.
13491006
1350 - `ScopedAPIKeyActor object`
1007 - `BetaSpendLimitScopedAPIKeyActor object`
13511008
13521009 A scoped Admin API key acting on behalf of the organization.
13531010
from line 1030
13731030
13741031 format: date-time
13751032
1376 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
1377
1378 - `UserActor object`
1033 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
1034
1035 - `BetaSpendLimitUserActor object`
13791036
13801037 A user within the organization. `name` and `email_address` are
13811038 null when the underlying account is unavailable or has been deleted;
13821039 `deleted` is true only for deleted accounts.
13831040
1384 - `type: "user_actor"`
1385
1386 Actor type. Always `user_actor`.
1387
1388 default: user_actor
1389
1390 - `deleted: boolean`
1391
1392 True only when the underlying account has been deleted.
1393
1394 default: false
1395
1396 - `email_address: string or null`
1397
1398 The user's email address. Null when the account is unavailable or has been deleted.
1399
1400 - `name: string or null`
1401
1402 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1403
1404 - `user_id: string`
1405
1406 Tagged ID of the user.
1407
1408 - `ScopedAPIKeyActor object`
1041 - `BetaSpendLimitScopedAPIKeyActor object`
14091042
14101043 A scoped Admin API key acting on behalf of the organization.
14111044
1412 - `type: "scoped_api_key_actor"`
1413
1414 default: scoped_api_key_actor
1415
1416 - `scoped_api_key_id: string`
1417
14181045 - `spend_summary: BetaSpendSummary or null`
14191046
14201047 Per-member effective-limit report row (`GET /spend_limits/effective`).
14211048
1422 - `actor: UserActor or ScopedAPIKeyActor`
1423
1424 - `UserActor object`
1049 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1050
1051 - `BetaSpendLimitUserActor object`
14251052
14261053 A user within the organization. `name` and `email_address` are
14271054 null when the underlying account is unavailable or has been deleted;
14281055 `deleted` is true only for deleted accounts.
14291056
1430 - `type: "user_actor"`
1431
1432 Actor type. Always `user_actor`.
1433
1434 default: user_actor
1435
1436 - `deleted: boolean`
1437
1438 True only when the underlying account has been deleted.
1439
1440 default: false
1441
1442 - `email_address: string or null`
1443
1444 The user's email address. Null when the account is unavailable or has been deleted.
1445
1446 - `name: string or null`
1447
1448 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1057 - `BetaSpendLimitScopedAPIKeyActor object`
1058
1059 A scoped Admin API key acting on behalf of the organization.
1060
1061 - `amount: string or null`
1062
1063 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.
1064
1065 - `currency: string`
1066
1067 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1068
1069 - `period: BetaSpendLimitPeriod`
1070
1071 Period this row's effective limit and spend are reported for.
1072
1073 - `period_to_date_spend: string`
1074
1075 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.
1076
1077 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1078
1079 - `BetaSpendLimitUserScope object`
1080
1081 Scope selecting a single member of the organization.
1082
1083 - `type: "user"`
1084
1085 Scope type. Always `user` for this scope.
1086
1087 default: user
14491088
14501089 - `user_id: string`
14511090
1452 Tagged ID of the user.
1453
1454 - `ScopedAPIKeyActor object`
1455
1456 A scoped Admin API key acting on behalf of the organization.
1457
1458 - `type: "scoped_api_key_actor"`
1459
1460 default: scoped_api_key_actor
1461
1462 - `scoped_api_key_id: string`
1463
1464 - `amount: string or null`
1465
1466 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.
1467
1468 - `currency: string`
1469
1470 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1471
1472 - `period: BetaSpendLimitPeriod`
1473
1474 Period this row's effective limit and spend are reported for.
1475
1476 - `period_to_date_spend: string`
1477
1478 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.
1479
1480 - `scope: User or SeatTier or RBACGroup or 3 more`
1481
1482 - `User object`
1091 Tagged ID of the member the spend limit applies to.
1092
1093 - `BetaSpendLimitSeatTierScope object`
1094
1095 - `type: "seat_tier"`
1096
1097 default: seat_tier
1098
1099 - `seat_tier: string`
1100
1101 - `BetaSpendLimitRBACGroupScope object`
1102
1103 - `type: "rbac_group"`
1104
1105 default: rbac_group
1106
1107 - `rbac_group_id: string`
1108
1109 - `BetaSpendLimitOrganizationServiceScope object`
1110
1111 - `type: "organization_service"`
1112
1113 default: organization_service
1114
1115 - `service: string`
1116
1117 - `BetaSpendLimitOrganizationScope object`
1118
1119 - `type: "organization"`
1120
1121 default: organization
1122
1123 - `BetaSpendLimitWorkspaceScope object`
1124
1125 Scope selecting one workspace of a Claude Console organization.
1126
1127 - `type: "workspace"`
1128
1129 Scope type. Always `workspace` for this scope.
1130
1131 default: workspace
1132
1133 - `workspace_id: string`
1134
1135 Tagged ID of the workspace the spend limit applies to.
1136
1137 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1138
1139 - `BetaSpendLimitUserScope object`
14831140
14841141 Scope selecting a single member of the organization.
14851142
1486 - `type: "user"`
1487
1488 Scope type. Always `user` for this scope.
1489
1490 default: user
1491
1492 - `user_id: string`
1493
1494 Tagged ID of the member the spend limit applies to.
1495
1496 - `SeatTier object`
1497
1498 - `type: "seat_tier"`
1499
1500 default: seat_tier
1501
1502 - `seat_tier: string`
1503
1504 - `RBACGroup object`
1505
1506 - `type: "rbac_group"`
1507
1508 default: rbac_group
1509
1510 - `rbac_group_id: string`
1511
1512 - `OrganizationService object`
1513
1514 - `type: "organization_service"`
1515
1516 default: organization_service
1517
1518 - `service: string`
1519
1520 - `Organization object`
1521
1522 - `type: "organization"`
1523
1524 default: organization
1525
1526 - `Workspace object`
1143 - `BetaSpendLimitSeatTierScope object`
1144
1145 - `BetaSpendLimitRBACGroupScope object`
1146
1147 - `BetaSpendLimitOrganizationServiceScope object`
1148
1149 - `BetaSpendLimitOrganizationScope object`
1150
1151 - `BetaSpendLimitWorkspaceScope object`
15271152
15281153 Scope selecting one workspace of a Claude Console organization.
1529
1530 - `type: "workspace"`
1531
1532 Scope type. Always `workspace` for this scope.
1533
1534 default: workspace
1535
1536 - `workspace_id: string`
1537
1538 Tagged ID of the workspace the spend limit applies to.
1539
1540 - `source: User or SeatTier or RBACGroup or 3 more`
1541
1542 - `User object`
1543
1544 Scope selecting a single member of the organization.
1545
1546 - `type: "user"`
1547
1548 Scope type. Always `user` for this scope.
1549
1550 default: user
1551
1552 - `user_id: string`
1553
1554 Tagged ID of the member the spend limit applies to.
1555
1556 - `SeatTier object`
1557
1558 - `type: "seat_tier"`
1559
1560 default: seat_tier
1561
1562 - `seat_tier: string`
1563
1564 - `RBACGroup object`
1565
1566 - `type: "rbac_group"`
1567
1568 default: rbac_group
1569
1570 - `rbac_group_id: string`
1571
1572 - `OrganizationService object`
1573
1574 - `type: "organization_service"`
1575
1576 default: organization_service
1577
1578 - `service: string`
1579
1580 - `Organization object`
1581
1582 - `type: "organization"`
1583
1584 default: organization
1585
1586 - `Workspace object`
1587
1588 Scope selecting one workspace of a Claude Console organization.
1589
1590 - `type: "workspace"`
1591
1592 Scope type. Always `workspace` for this scope.
1593
1594 default: workspace
1595
1596 - `workspace_id: string`
1597
1598 Tagged ID of the workspace the spend limit applies to.
15991154
16001155 - `spend_limit_id: string`
16011156
from line 1233
16781233
16791234 - `id: string`
16801235
1681 - `actor: UserActor or ScopedAPIKeyActor`
1682
1683 - `UserActor object`
1236 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1237
1238 - `BetaSpendLimitUserActor object`
16841239
16851240 A user within the organization. `name` and `email_address` are
16861241 null when the underlying account is unavailable or has been deleted;
from line 1265
17101265
17111266 Tagged ID of the user.
17121267
1713 - `ScopedAPIKeyActor object`
1268 - `BetaSpendLimitScopedAPIKeyActor object`
17141269
17151270 A scoped Admin API key acting on behalf of the organization.
17161271
from line 1291
17361291
17371292 format: date-time
17381293
1739 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
1740
1741 - `UserActor object`
1294 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
1295
1296 - `BetaSpendLimitUserActor object`
17421297
17431298 A user within the organization. `name` and `email_address` are
17441299 null when the underlying account is unavailable or has been deleted;
17451300 `deleted` is true only for deleted accounts.
17461301
1747 - `type: "user_actor"`
1748
1749 Actor type. Always `user_actor`.
1750
1751 default: user_actor
1752
1753 - `deleted: boolean`
1754
1755 True only when the underlying account has been deleted.
1756
1757 default: false
1758
1759 - `email_address: string or null`
1760
1761 The user's email address. Null when the account is unavailable or has been deleted.
1762
1763 - `name: string or null`
1764
1765 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1766
1767 - `user_id: string`
1768
1769 Tagged ID of the user.
1770
1771 - `ScopedAPIKeyActor object`
1302 - `BetaSpendLimitScopedAPIKeyActor object`
17721303
17731304 A scoped Admin API key acting on behalf of the organization.
17741305
1775 - `type: "scoped_api_key_actor"`
1776
1777 default: scoped_api_key_actor
1778
1779 - `scoped_api_key_id: string`
1780
17811306 - `spend_summary: BetaSpendSummary or null`
17821307
17831308 Per-member effective-limit report row (`GET /spend_limits/effective`).
17841309
1785 - `actor: UserActor or ScopedAPIKeyActor`
1786
1787 - `UserActor object`
1310 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1311
1312 - `BetaSpendLimitUserActor object`
17881313
17891314 A user within the organization. `name` and `email_address` are
17901315 null when the underlying account is unavailable or has been deleted;
17911316 `deleted` is true only for deleted accounts.
17921317
1793 - `type: "user_actor"`
1794
1795 Actor type. Always `user_actor`.
1796
1797 default: user_actor
1798
1799 - `deleted: boolean`
1800
1801 True only when the underlying account has been deleted.
1802
1803 default: false
1804
1805 - `email_address: string or null`
1806
1807 The user's email address. Null when the account is unavailable or has been deleted.
1808
1809 - `name: string or null`
1810
1811 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1318 - `BetaSpendLimitScopedAPIKeyActor object`
1319
1320 A scoped Admin API key acting on behalf of the organization.
1321
1322 - `amount: string or null`
1323
1324 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.
1325
1326 - `currency: string`
1327
1328 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1329
1330 - `period: BetaSpendLimitPeriod`
1331
1332 Period this row's effective limit and spend are reported for.
1333
1334 - `period_to_date_spend: string`
1335
1336 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.
1337
1338 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1339
1340 - `BetaSpendLimitUserScope object`
1341
1342 Scope selecting a single member of the organization.
1343
1344 - `type: "user"`
1345
1346 Scope type. Always `user` for this scope.
1347
1348 default: user
18121349
18131350 - `user_id: string`
18141351
1815 Tagged ID of the user.
1816
1817 - `ScopedAPIKeyActor object`
1818
1819 A scoped Admin API key acting on behalf of the organization.
1820
1821 - `type: "scoped_api_key_actor"`
1822
1823 default: scoped_api_key_actor
1824
1825 - `scoped_api_key_id: string`
1826
1827 - `amount: string or null`
1828
1829 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.
1830
1831 - `currency: string`
1832
1833 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1834
1835 - `period: BetaSpendLimitPeriod`
1836
1837 Period this row's effective limit and spend are reported for.
1838
1839 - `period_to_date_spend: string`
1840
1841 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.
1842
1843 - `scope: User or SeatTier or RBACGroup or 3 more`
1844
1845 - `User object`
1352 Tagged ID of the member the spend limit applies to.
1353
1354 - `BetaSpendLimitSeatTierScope object`
1355
1356 - `type: "seat_tier"`
1357
1358 default: seat_tier
1359
1360 - `seat_tier: string`
1361
1362 - `BetaSpendLimitRBACGroupScope object`
1363
1364 - `type: "rbac_group"`
1365
1366 default: rbac_group
1367
1368 - `rbac_group_id: string`
1369
1370 - `BetaSpendLimitOrganizationServiceScope object`
1371
1372 - `type: "organization_service"`
1373
1374 default: organization_service
1375
1376 - `service: string`
1377
1378 - `BetaSpendLimitOrganizationScope object`
1379
1380 - `type: "organization"`
1381
1382 default: organization
1383
1384 - `BetaSpendLimitWorkspaceScope object`
1385
1386 Scope selecting one workspace of a Claude Console organization.
1387
1388 - `type: "workspace"`
1389
1390 Scope type. Always `workspace` for this scope.
1391
1392 default: workspace
1393
1394 - `workspace_id: string`
1395
1396 Tagged ID of the workspace the spend limit applies to.
1397
1398 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1399
1400 - `BetaSpendLimitUserScope object`
18461401
18471402 Scope selecting a single member of the organization.
18481403
1849 - `type: "user"`
1850
1851 Scope type. Always `user` for this scope.
1852
1853 default: user
1854
1855 - `user_id: string`
1856
1857 Tagged ID of the member the spend limit applies to.
1858
1859 - `SeatTier object`
1860
1861 - `type: "seat_tier"`
1862
1863 default: seat_tier
1864
1865 - `seat_tier: string`
1866
1867 - `RBACGroup object`
1868
1869 - `type: "rbac_group"`
1870
1871 default: rbac_group
1872
1873 - `rbac_group_id: string`
1874
1875 - `OrganizationService object`
1876
1877 - `type: "organization_service"`
1878
1879 default: organization_service
1880
1881 - `service: string`
1882
1883 - `Organization object`
1884
1885 - `type: "organization"`
1886
1887 default: organization
1888
1889 - `Workspace object`
1404 - `BetaSpendLimitSeatTierScope object`
1405
1406 - `BetaSpendLimitRBACGroupScope object`
1407
1408 - `BetaSpendLimitOrganizationServiceScope object`
1409
1410 - `BetaSpendLimitOrganizationScope object`
1411
1412 - `BetaSpendLimitWorkspaceScope object`
18901413
18911414 Scope selecting one workspace of a Claude Console organization.
18921415
1893 - `type: "workspace"`
1894
1895 Scope type. Always `workspace` for this scope.
1896
1897 default: workspace
1898
1899 - `workspace_id: string`
1900
1901 Tagged ID of the workspace the spend limit applies to.
1902
1903 - `source: User or SeatTier or RBACGroup or 3 more`
1904
1905 - `User object`
1906
1907 Scope selecting a single member of the organization.
1908
1909 - `type: "user"`
1910
1911 Scope type. Always `user` for this scope.
1912
1913 default: user
1914
1915 - `user_id: string`
1916
1917 Tagged ID of the member the spend limit applies to.
1918
1919 - `SeatTier object`
1920
1921 - `type: "seat_tier"`
1922
1923 default: seat_tier
1924
1925 - `seat_tier: string`
1926
1927 - `RBACGroup object`
1928
1929 - `type: "rbac_group"`
1930
1931 default: rbac_group
1932
1933 - `rbac_group_id: string`
1934
1935 - `OrganizationService object`
1936
1937 - `type: "organization_service"`
1938
1939 default: organization_service
1940
1941 - `service: string`
1942
1943 - `Organization object`
1944
1945 - `type: "organization"`
1946
1947 default: organization
1948
1949 - `Workspace object`
1950
1951 Scope selecting one workspace of a Claude Console organization.
1952
1953 - `type: "workspace"`
1954
1955 Scope type. Always `workspace` for this scope.
1956
1957 default: workspace
1958
1959 - `workspace_id: string`
1960
1961 Tagged ID of the workspace the spend limit applies to.
1962
19631416 - `spend_limit_id: string`
19641417
19651418 - `status: BetaSpendLimitIncreaseRequestStatus`
from line 1443
19901443
19911444 - `id: string`
19921445
1993 - `actor: UserActor or ScopedAPIKeyActor`
1994
1995 - `UserActor object`
1446 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1447
1448 - `BetaSpendLimitUserActor object`
19961449
19971450 A user within the organization. `name` and `email_address` are
19981451 null when the underlying account is unavailable or has been deleted;
from line 1475
20221475
20231476 Tagged ID of the user.
20241477
2025 - `ScopedAPIKeyActor object`
1478 - `BetaSpendLimitScopedAPIKeyActor object`
20261479
20271480 A scoped Admin API key acting on behalf of the organization.
20281481
from line 1501
20481501
20491502 format: date-time
20501503
2051 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
2052
2053 - `UserActor object`
1504 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
1505
1506 - `BetaSpendLimitUserActor object`
20541507
20551508 A user within the organization. `name` and `email_address` are
20561509 null when the underlying account is unavailable or has been deleted;
20571510 `deleted` is true only for deleted accounts.
20581511
2059 - `type: "user_actor"`
2060
2061 Actor type. Always `user_actor`.
2062
2063 default: user_actor
2064
2065 - `deleted: boolean`
2066
2067 True only when the underlying account has been deleted.
2068
2069 default: false
2070
2071 - `email_address: string or null`
2072
2073 The user's email address. Null when the account is unavailable or has been deleted.
2074
2075 - `name: string or null`
2076
2077 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2078
2079 - `user_id: string`
2080
2081 Tagged ID of the user.
2082
2083 - `ScopedAPIKeyActor object`
1512 - `BetaSpendLimitScopedAPIKeyActor object`
20841513
20851514 A scoped Admin API key acting on behalf of the organization.
20861515
2087 - `type: "scoped_api_key_actor"`
2088
2089 default: scoped_api_key_actor
2090
2091 - `scoped_api_key_id: string`
2092
20931516 - `spend_limit: BetaSpendLimit`
20941517
20951518 A configured spend limit: a cap on metered spend for one scope and period.
from line 1541
21181541
21191542 ISO 4217 code of the organization's billing currency; the unit for `amount`.
21201543
1544 - `is_enabled: boolean`
1545
1546 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.
1547
21211548 - `period: BetaSpendLimitPeriod`
21221549
21231550 Length of the window the limit resets over. `amount` caps spend within each period.
21241551
2125 - `scope: User or SeatTier or RBACGroup or 3 more`
1552 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
21261553
21271554 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
21281555
2129 - `User object`
1556 - `BetaSpendLimitUserScope object`
21301557
21311558 Scope selecting a single member of the organization.
21321559
from line 1567
21401567
21411568 Tagged ID of the member the spend limit applies to.
21421569
2143 - `SeatTier object`
1570 - `BetaSpendLimitSeatTierScope object`
21441571
21451572 - `type: "seat_tier"`
21461573
from line 1575
21481575
21491576 - `seat_tier: string`
21501577
2151 - `RBACGroup object`
1578 - `BetaSpendLimitRBACGroupScope object`
21521579
21531580 - `type: "rbac_group"`
21541581
from line 1583
21561583
21571584 - `rbac_group_id: string`
21581585
2159 - `OrganizationService object`
1586 - `BetaSpendLimitOrganizationServiceScope object`
21601587
21611588 - `type: "organization_service"`
21621589
from line 1591
21641591
21651592 - `service: string`
21661593
2167 - `Organization object`
1594 - `BetaSpendLimitOrganizationScope object`
21681595
21691596 - `type: "organization"`
21701597
21711598 default: organization
21721599
2173 - `Workspace object`
1600 - `BetaSpendLimitWorkspaceScope object`
21741601
21751602 Scope selecting one workspace of a Claude Console organization.
21761603
from line 1621
21941621
21951622 Per-member effective-limit report row (`GET /spend_limits/effective`).
21961623
2197 - `actor: UserActor or ScopedAPIKeyActor`
2198
2199 - `UserActor object`
1624 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
1625
1626 - `BetaSpendLimitUserActor object`
22001627
22011628 A user within the organization. `name` and `email_address` are
22021629 null when the underlying account is unavailable or has been deleted;
22031630 `deleted` is true only for deleted accounts.
22041631
2205 - `type: "user_actor"`
2206
2207 Actor type. Always `user_actor`.
2208
2209 default: user_actor
2210
2211 - `deleted: boolean`
2212
2213 True only when the underlying account has been deleted.
2214
2215 default: false
2216
2217 - `email_address: string or null`
2218
2219 The user's email address. Null when the account is unavailable or has been deleted.
2220
2221 - `name: string or null`
2222
2223 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2224
2225 - `user_id: string`
2226
2227 Tagged ID of the user.
2228
2229 - `ScopedAPIKeyActor object`
1632 - `BetaSpendLimitScopedAPIKeyActor object`
22301633
22311634 A scoped Admin API key acting on behalf of the organization.
22321635
2233 - `type: "scoped_api_key_actor"`
2234
2235 default: scoped_api_key_actor
2236
2237 - `scoped_api_key_id: string`
2238
22391636 - `amount: string or null`
22401637
22411638 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.
from line 1649
22521649
22531650 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.
22541651
2255 - `scope: User or SeatTier or RBACGroup or 3 more`
2256
2257 - `User object`
1652 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1653
1654 - `BetaSpendLimitUserScope object`
22581655
22591656 Scope selecting a single member of the organization.
22601657
2261 - `type: "user"`
2262
2263 Scope type. Always `user` for this scope.
2264
2265 default: user
2266
2267 - `user_id: string`
2268
2269 Tagged ID of the member the spend limit applies to.
2270
2271 - `SeatTier object`
2272
2273 - `type: "seat_tier"`
2274
2275 default: seat_tier
2276
2277 - `seat_tier: string`
2278
2279 - `RBACGroup object`
2280
2281 - `type: "rbac_group"`
2282
2283 default: rbac_group
2284
2285 - `rbac_group_id: string`
2286
2287 - `OrganizationService object`
2288
2289 - `type: "organization_service"`
2290
2291 default: organization_service
2292
2293 - `service: string`
2294
2295 - `Organization object`
2296
2297 - `type: "organization"`
2298
2299 default: organization
2300
2301 - `Workspace object`
1658 - `BetaSpendLimitSeatTierScope object`
1659
1660 - `BetaSpendLimitRBACGroupScope object`
1661
1662 - `BetaSpendLimitOrganizationServiceScope object`
1663
1664 - `BetaSpendLimitOrganizationScope object`
1665
1666 - `BetaSpendLimitWorkspaceScope object`
23021667
23031668 Scope selecting one workspace of a Claude Console organization.
23041669
2305 - `type: "workspace"`
2306
2307 Scope type. Always `workspace` for this scope.
2308
2309 default: workspace
2310
2311 - `workspace_id: string`
2312
2313 Tagged ID of the workspace the spend limit applies to.
2314
2315 - `source: User or SeatTier or RBACGroup or 3 more`
2316
2317 - `User object`
1670 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
1671
1672 - `BetaSpendLimitUserScope object`
23181673
23191674 Scope selecting a single member of the organization.
23201675
2321 - `type: "user"`
2322
2323 Scope type. Always `user` for this scope.
2324
2325 default: user
2326
2327 - `user_id: string`
2328
2329 Tagged ID of the member the spend limit applies to.
2330
2331 - `SeatTier object`
2332
2333 - `type: "seat_tier"`
2334
2335 default: seat_tier
2336
2337 - `seat_tier: string`
2338
2339 - `RBACGroup object`
2340
2341 - `type: "rbac_group"`
2342
2343 default: rbac_group
2344
2345 - `rbac_group_id: string`
2346
2347 - `OrganizationService object`
2348
2349 - `type: "organization_service"`
2350
2351 default: organization_service
2352
2353 - `service: string`
2354
2355 - `Organization object`
2356
2357 - `type: "organization"`
2358
2359 default: organization
2360
2361 - `Workspace object`
1676 - `BetaSpendLimitSeatTierScope object`
1677
1678 - `BetaSpendLimitRBACGroupScope object`
1679
1680 - `BetaSpendLimitOrganizationServiceScope object`
1681
1682 - `BetaSpendLimitOrganizationScope object`
1683
1684 - `BetaSpendLimitWorkspaceScope object`
23621685
23631686 Scope selecting one workspace of a Claude Console organization.
23641687
2365 - `type: "workspace"`
2366
2367 Scope type. Always `workspace` for this scope.
2368
2369 default: workspace
2370
2371 - `workspace_id: string`
2372
2373 Tagged ID of the workspace the spend limit applies to.
2374
23751688 - `spend_limit_id: string`
23761689
23771690 - `status: BetaSpendLimitIncreaseRequestStatus`
23781691
api/beta/organization/spend_limits/increase_requests/approve Changed · +48 / -187 lines
from line 44
4444
4545- `id: string`
4646
47- `actor: UserActor or ScopedAPIKeyActor`
47- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
4848
49 - `UserActor object`
49 - `BetaSpendLimitUserActor object`
5050
5151 A user within the organization. `name` and `email_address` are
5252 null when the underlying account is unavailable or has been deleted;
from line 76
7676
7777 Tagged ID of the user.
7878
79 - `ScopedAPIKeyActor object`
79 - `BetaSpendLimitScopedAPIKeyActor object`
8080
8181 A scoped Admin API key acting on behalf of the organization.
8282
from line 102
102102
103103 format: date-time
104104
105- `resolved_by: UserActor or ScopedAPIKeyActor or null`
105- `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
106106
107 - `UserActor object`
107 - `BetaSpendLimitUserActor object`
108108
109109 A user within the organization. `name` and `email_address` are
110110 null when the underlying account is unavailable or has been deleted;
111111 `deleted` is true only for deleted accounts.
112112
113 - `type: "user_actor"`
113 - `BetaSpendLimitScopedAPIKeyActor object`
114114
115 Actor type. Always `user_actor`.
116
117 default: user_actor
118
119 - `deleted: boolean`
120
121 True only when the underlying account has been deleted.
122
123 default: false
124
125 - `email_address: string or null`
126
127 The user's email address. Null when the account is unavailable or has been deleted.
128
129 - `name: string or null`
130
131 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
132
133 - `user_id: string`
134
135 Tagged ID of the user.
136
137 - `ScopedAPIKeyActor object`
138
139115 A scoped Admin API key acting on behalf of the organization.
140116
141 - `type: "scoped_api_key_actor"`
142
143 default: scoped_api_key_actor
144
145 - `scoped_api_key_id: string`
146
147117- `spend_limit: BetaSpendLimit`
148118
149119 A configured spend limit: a cap on metered spend for one scope and period.
from line 142
172142
173143 ISO 4217 code of the organization's billing currency; the unit for `amount`.
174144
145 - `is_enabled: boolean`
146
147 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.
148
175149 - `period: BetaSpendLimitPeriod`
176150
177151 Length of the window the limit resets over. `amount` caps spend within each period.
178152
179 - `scope: User or SeatTier or RBACGroup or 3 more`
153 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
180154
181155 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
182156
183 - `User object`
157 - `BetaSpendLimitUserScope object`
184158
185159 Scope selecting a single member of the organization.
186160
from line 168
194168
195169 Tagged ID of the member the spend limit applies to.
196170
197 - `SeatTier object`
171 - `BetaSpendLimitSeatTierScope object`
198172
199173 - `type: "seat_tier"`
200174
from line 176
202176
203177 - `seat_tier: string`
204178
205 - `RBACGroup object`
179 - `BetaSpendLimitRBACGroupScope object`
206180
207181 - `type: "rbac_group"`
208182
from line 184
210184
211185 - `rbac_group_id: string`
212186
213 - `OrganizationService object`
187 - `BetaSpendLimitOrganizationServiceScope object`
214188
215189 - `type: "organization_service"`
216190
from line 192
218192
219193 - `service: string`
220194
221 - `Organization object`
195 - `BetaSpendLimitOrganizationScope object`
222196
223197 - `type: "organization"`
224198
225199 default: organization
226200
227 - `Workspace object`
201 - `BetaSpendLimitWorkspaceScope object`
228202
229203 Scope selecting one workspace of a Claude Console organization.
230204
from line 222
248222
249223 Per-member effective-limit report row (`GET /spend_limits/effective`).
250224
251 - `actor: UserActor or ScopedAPIKeyActor`
225 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
252226
253 - `UserActor object`
227 - `BetaSpendLimitUserActor object`
254228
255229 A user within the organization. `name` and `email_address` are
256230 null when the underlying account is unavailable or has been deleted;
257231 `deleted` is true only for deleted accounts.
258232
259 - `type: "user_actor"`
233 - `BetaSpendLimitScopedAPIKeyActor object`
260234
261 Actor type. Always `user_actor`.
262
263 default: user_actor
264
265 - `deleted: boolean`
266
267 True only when the underlying account has been deleted.
268
269 default: false
270
271 - `email_address: string or null`
272
273 The user's email address. Null when the account is unavailable or has been deleted.
274
275 - `name: string or null`
276
277 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
278
279 - `user_id: string`
280
281 Tagged ID of the user.
282
283 - `ScopedAPIKeyActor object`
284
285235 A scoped Admin API key acting on behalf of the organization.
286236
287 - `type: "scoped_api_key_actor"`
288
289 default: scoped_api_key_actor
290
291 - `scoped_api_key_id: string`
292
293237 - `amount: string or null`
294238
295239 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.
from line 250
306250
307251 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.
308252
309 - `scope: User or SeatTier or RBACGroup or 3 more`
253 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
310254
311 - `User object`
255 - `BetaSpendLimitUserScope object`
312256
313257 Scope selecting a single member of the organization.
314258
315 - `type: "user"`
259 - `BetaSpendLimitSeatTierScope object`
316260
317 Scope type. Always `user` for this scope.
261 - `BetaSpendLimitRBACGroupScope object`
318262
319 default: user
263 - `BetaSpendLimitOrganizationServiceScope object`
320264
321 - `user_id: string`
265 - `BetaSpendLimitOrganizationScope object`
322266
323 Tagged ID of the member the spend limit applies to.
267 - `BetaSpendLimitWorkspaceScope object`
324268
325 - `SeatTier object`
326
327 - `type: "seat_tier"`
328
329 default: seat_tier
330
331 - `seat_tier: string`
332
333 - `RBACGroup object`
334
335 - `type: "rbac_group"`
336
337 default: rbac_group
338
339 - `rbac_group_id: string`
340
341 - `OrganizationService object`
342
343 - `type: "organization_service"`
344
345 default: organization_service
346
347 - `service: string`
348
349 - `Organization object`
350
351 - `type: "organization"`
352
353 default: organization
354
355 - `Workspace object`
356
357269 Scope selecting one workspace of a Claude Console organization.
358270
359 - `type: "workspace"`
271 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
360272
361 Scope type. Always `workspace` for this scope.
273 - `BetaSpendLimitUserScope object`
362274
363 default: workspace
364
365 - `workspace_id: string`
366
367 Tagged ID of the workspace the spend limit applies to.
368
369 - `source: User or SeatTier or RBACGroup or 3 more`
370
371 - `User object`
372
373275 Scope selecting a single member of the organization.
374276
375 - `type: "user"`
277 - `BetaSpendLimitSeatTierScope object`
376278
377 Scope type. Always `user` for this scope.
279 - `BetaSpendLimitRBACGroupScope object`
378280
379 default: user
281 - `BetaSpendLimitOrganizationServiceScope object`
380282
381 - `user_id: string`
283 - `BetaSpendLimitOrganizationScope object`
382284
383 Tagged ID of the member the spend limit applies to.
285 - `BetaSpendLimitWorkspaceScope object`
384286
385 - `SeatTier object`
386
387 - `type: "seat_tier"`
388
389 default: seat_tier
390
391 - `seat_tier: string`
392
393 - `RBACGroup object`
394
395 - `type: "rbac_group"`
396
397 default: rbac_group
398
399 - `rbac_group_id: string`
400
401 - `OrganizationService object`
402
403 - `type: "organization_service"`
404
405 default: organization_service
406
407 - `service: string`
408
409 - `Organization object`
410
411 - `type: "organization"`
412
413 default: organization
414
415 - `Workspace object`
416
417287 Scope selecting one workspace of a Claude Console organization.
418288
419 - `type: "workspace"`
420
421 Scope type. Always `workspace` for this scope.
422
423 default: workspace
424
425 - `workspace_id: string`
426
427 Tagged ID of the workspace the spend limit applies to.
428
429289 - `spend_limit_id: string`
430290
431291- `status: BetaSpendLimitIncreaseRequestStatus`
from line 336
476336 "amount": "50000",
477337 "created_at": "2019-12-27T18:11:19.117Z",
478338 "currency": "USD",
339 "is_enabled": true,
479340 "period": "daily",
480341 "scope": {
481342 "type": "user",
api/beta/organization/spend_limits/increase_requests/deny Changed · +100 / -202 lines
from line 32
3232
3333 - `id: string`
3434
35 - `actor: UserActor or ScopedAPIKeyActor`
35 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
3636
37 - `UserActor object`
37 - `BetaSpendLimitUserActor object`
3838
3939 A user within the organization. `name` and `email_address` are
4040 null when the underlying account is unavailable or has been deleted;
from line 64
6464
6565 Tagged ID of the user.
6666
67 - `ScopedAPIKeyActor object`
67 - `BetaSpendLimitScopedAPIKeyActor object`
6868
6969 A scoped Admin API key acting on behalf of the organization.
7070
from line 90
9090
9191 format: date-time
9292
93 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
93 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
9494
95 - `UserActor object`
95 - `BetaSpendLimitUserActor object`
9696
9797 A user within the organization. `name` and `email_address` are
9898 null when the underlying account is unavailable or has been deleted;
9999 `deleted` is true only for deleted accounts.
100100
101 - `type: "user_actor"`
101 - `BetaSpendLimitScopedAPIKeyActor object`
102102
103 Actor type. Always `user_actor`.
104
105 default: user_actor
106
107 - `deleted: boolean`
108
109 True only when the underlying account has been deleted.
110
111 default: false
112
113 - `email_address: string or null`
114
115 The user's email address. Null when the account is unavailable or has been deleted.
116
117 - `name: string or null`
118
119 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
120
121 - `user_id: string`
122
123 Tagged ID of the user.
124
125 - `ScopedAPIKeyActor object`
126
127103 A scoped Admin API key acting on behalf of the organization.
128104
129 - `type: "scoped_api_key_actor"`
130
131 default: scoped_api_key_actor
132
133 - `scoped_api_key_id: string`
134
135105 - `spend_summary: BetaSpendSummary or null`
136106
137107 Per-member effective-limit report row (`GET /spend_limits/effective`).
138108
139 - `actor: UserActor or ScopedAPIKeyActor`
109 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
140110
141 - `UserActor object`
111 - `BetaSpendLimitUserActor object`
142112
143113 A user within the organization. `name` and `email_address` are
144114 null when the underlying account is unavailable or has been deleted;
145115 `deleted` is true only for deleted accounts.
146116
147 - `type: "user_actor"`
117 - `BetaSpendLimitScopedAPIKeyActor object`
148118
149 Actor type. Always `user_actor`.
150
151 default: user_actor
152
153 - `deleted: boolean`
154
155 True only when the underlying account has been deleted.
156
157 default: false
158
159 - `email_address: string or null`
160
161 The user's email address. Null when the account is unavailable or has been deleted.
162
163 - `name: string or null`
164
165 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
166
167 - `user_id: string`
168
169 Tagged ID of the user.
170
171 - `ScopedAPIKeyActor object`
172
173119 A scoped Admin API key acting on behalf of the organization.
174120
175 - `type: "scoped_api_key_actor"`
176
177 default: scoped_api_key_actor
178
179 - `scoped_api_key_id: string`
180
181121 - `amount: string or null`
182122
183123 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.
from line 134
194134
195135 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.
196136
197 - `scope: User or SeatTier or RBACGroup or 3 more`
137 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
198138
199 - `User object`
139 - `BetaSpendLimitUserScope object`
200140
201141 Scope selecting a single member of the organization.
202142
from line 150
210150
211151 Tagged ID of the member the spend limit applies to.
212152
213 - `SeatTier object`
153 - `BetaSpendLimitSeatTierScope object`
214154
215155 - `type: "seat_tier"`
216156
from line 158
218158
219159 - `seat_tier: string`
220160
221 - `RBACGroup object`
161 - `BetaSpendLimitRBACGroupScope object`
222162
223163 - `type: "rbac_group"`
224164
from line 166
226166
227167 - `rbac_group_id: string`
228168
229 - `OrganizationService object`
169 - `BetaSpendLimitOrganizationServiceScope object`
230170
231171 - `type: "organization_service"`
232172
from line 174
234174
235175 - `service: string`
236176
237 - `Organization object`
177 - `BetaSpendLimitOrganizationScope object`
238178
239179 - `type: "organization"`
240180
241181 default: organization
242182
243 - `Workspace object`
183 - `BetaSpendLimitWorkspaceScope object`
244184
245185 Scope selecting one workspace of a Claude Console organization.
246186
from line 194
254194
255195 Tagged ID of the workspace the spend limit applies to.
256196
257 - `source: User or SeatTier or RBACGroup or 3 more`
197 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
258198
259 - `User object`
199 - `BetaSpendLimitUserScope object`
260200
261201 Scope selecting a single member of the organization.
262202
263 - `type: "user"`
203 - `BetaSpendLimitSeatTierScope object`
264204
265 Scope type. Always `user` for this scope.
205 - `BetaSpendLimitRBACGroupScope object`
266206
267 default: user
207 - `BetaSpendLimitOrganizationServiceScope object`
268208
269 - `user_id: string`
209 - `BetaSpendLimitOrganizationScope object`
270210
271 Tagged ID of the member the spend limit applies to.
211 - `BetaSpendLimitWorkspaceScope object`
272212
273 - `SeatTier object`
274
275 - `type: "seat_tier"`
276
277 default: seat_tier
278
279 - `seat_tier: string`
280
281 - `RBACGroup object`
282
283 - `type: "rbac_group"`
284
285 default: rbac_group
286
287 - `rbac_group_id: string`
288
289 - `OrganizationService object`
290
291 - `type: "organization_service"`
292
293 default: organization_service
294
295 - `service: string`
296
297 - `Organization object`
298
299 - `type: "organization"`
300
301 default: organization
302
303 - `Workspace object`
304
305213 Scope selecting one workspace of a Claude Console organization.
306
307 - `type: "workspace"`
308
309 Scope type. Always `workspace` for this scope.
310
311 default: workspace
312
313 - `workspace_id: string`
314
315 Tagged ID of the workspace the spend limit applies to.
316214
317215 - `spend_limit_id: string`
318216
api/beta/organization/spend_limits/increase_requests/list Changed · +100 / -202 lines
from line 46
4646
4747 - `id: string`
4848
49 - `actor: UserActor or ScopedAPIKeyActor`
49 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
5050
51 - `UserActor object`
51 - `BetaSpendLimitUserActor object`
5252
5353 A user within the organization. `name` and `email_address` are
5454 null when the underlying account is unavailable or has been deleted;
from line 78
7878
7979 Tagged ID of the user.
8080
81 - `ScopedAPIKeyActor object`
81 - `BetaSpendLimitScopedAPIKeyActor object`
8282
8383 A scoped Admin API key acting on behalf of the organization.
8484
from line 104
104104
105105 format: date-time
106106
107 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
107 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
108108
109 - `UserActor object`
109 - `BetaSpendLimitUserActor object`
110110
111111 A user within the organization. `name` and `email_address` are
112112 null when the underlying account is unavailable or has been deleted;
113113 `deleted` is true only for deleted accounts.
114114
115 - `type: "user_actor"`
115 - `BetaSpendLimitScopedAPIKeyActor object`
116116
117 Actor type. Always `user_actor`.
118
119 default: user_actor
120
121 - `deleted: boolean`
122
123 True only when the underlying account has been deleted.
124
125 default: false
126
127 - `email_address: string or null`
128
129 The user's email address. Null when the account is unavailable or has been deleted.
130
131 - `name: string or null`
132
133 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
134
135 - `user_id: string`
136
137 Tagged ID of the user.
138
139 - `ScopedAPIKeyActor object`
140
141117 A scoped Admin API key acting on behalf of the organization.
142118
143 - `type: "scoped_api_key_actor"`
144
145 default: scoped_api_key_actor
146
147 - `scoped_api_key_id: string`
148
149119 - `spend_summary: BetaSpendSummary or null`
150120
151121 Per-member effective-limit report row (`GET /spend_limits/effective`).
152122
153 - `actor: UserActor or ScopedAPIKeyActor`
123 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
154124
155 - `UserActor object`
125 - `BetaSpendLimitUserActor object`
156126
157127 A user within the organization. `name` and `email_address` are
158128 null when the underlying account is unavailable or has been deleted;
159129 `deleted` is true only for deleted accounts.
160130
161 - `type: "user_actor"`
131 - `BetaSpendLimitScopedAPIKeyActor object`
162132
163 Actor type. Always `user_actor`.
164
165 default: user_actor
166
167 - `deleted: boolean`
168
169 True only when the underlying account has been deleted.
170
171 default: false
172
173 - `email_address: string or null`
174
175 The user's email address. Null when the account is unavailable or has been deleted.
176
177 - `name: string or null`
178
179 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
180
181 - `user_id: string`
182
183 Tagged ID of the user.
184
185 - `ScopedAPIKeyActor object`
186
187133 A scoped Admin API key acting on behalf of the organization.
188134
189 - `type: "scoped_api_key_actor"`
190
191 default: scoped_api_key_actor
192
193 - `scoped_api_key_id: string`
194
195135 - `amount: string or null`
196136
197137 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.
from line 148
208148
209149 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.
210150
211 - `scope: User or SeatTier or RBACGroup or 3 more`
151 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
212152
213 - `User object`
153 - `BetaSpendLimitUserScope object`
214154
215155 Scope selecting a single member of the organization.
216156
from line 164
224164
225165 Tagged ID of the member the spend limit applies to.
226166
227 - `SeatTier object`
167 - `BetaSpendLimitSeatTierScope object`
228168
229169 - `type: "seat_tier"`
230170
from line 172
232172
233173 - `seat_tier: string`
234174
235 - `RBACGroup object`
175 - `BetaSpendLimitRBACGroupScope object`
236176
237177 - `type: "rbac_group"`
238178
from line 180
240180
241181 - `rbac_group_id: string`
242182
243 - `OrganizationService object`
183 - `BetaSpendLimitOrganizationServiceScope object`
244184
245185 - `type: "organization_service"`
246186
from line 188
248188
249189 - `service: string`
250190
251 - `Organization object`
191 - `BetaSpendLimitOrganizationScope object`
252192
253193 - `type: "organization"`
254194
255195 default: organization
256196
257 - `Workspace object`
197 - `BetaSpendLimitWorkspaceScope object`
258198
259199 Scope selecting one workspace of a Claude Console organization.
260200
from line 208
268208
269209 Tagged ID of the workspace the spend limit applies to.
270210
271 - `source: User or SeatTier or RBACGroup or 3 more`
211 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
272212
273 - `User object`
213 - `BetaSpendLimitUserScope object`
274214
275215 Scope selecting a single member of the organization.
276216
277 - `type: "user"`
217 - `BetaSpendLimitSeatTierScope object`
278218
279 Scope type. Always `user` for this scope.
219 - `BetaSpendLimitRBACGroupScope object`
280220
281 default: user
221 - `BetaSpendLimitOrganizationServiceScope object`
282222
283 - `user_id: string`
223 - `BetaSpendLimitOrganizationScope object`
284224
285 Tagged ID of the member the spend limit applies to.
225 - `BetaSpendLimitWorkspaceScope object`
286226
287 - `SeatTier object`
288
289 - `type: "seat_tier"`
290
291 default: seat_tier
292
293 - `seat_tier: string`
294
295 - `RBACGroup object`
296
297 - `type: "rbac_group"`
298
299 default: rbac_group
300
301 - `rbac_group_id: string`
302
303 - `OrganizationService object`
304
305 - `type: "organization_service"`
306
307 default: organization_service
308
309 - `service: string`
310
311 - `Organization object`
312
313 - `type: "organization"`
314
315 default: organization
316
317 - `Workspace object`
318
319227 Scope selecting one workspace of a Claude Console organization.
320
321 - `type: "workspace"`
322
323 Scope type. Always `workspace` for this scope.
324
325 default: workspace
326
327 - `workspace_id: string`
328
329 Tagged ID of the workspace the spend limit applies to.
330228
331229 - `spend_limit_id: string`
332230
api/beta/organization/spend_limits/increase_requests/retrieve Changed · +100 / -202 lines
from line 28
2828
2929 - `id: string`
3030
31 - `actor: UserActor or ScopedAPIKeyActor`
31 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
3232
33 - `UserActor object`
33 - `BetaSpendLimitUserActor object`
3434
3535 A user within the organization. `name` and `email_address` are
3636 null when the underlying account is unavailable or has been deleted;
from line 60
6060
6161 Tagged ID of the user.
6262
63 - `ScopedAPIKeyActor object`
63 - `BetaSpendLimitScopedAPIKeyActor object`
6464
6565 A scoped Admin API key acting on behalf of the organization.
6666
from line 86
8686
8787 format: date-time
8888
89 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
89 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`
9090
91 - `UserActor object`
91 - `BetaSpendLimitUserActor object`
9292
9393 A user within the organization. `name` and `email_address` are
9494 null when the underlying account is unavailable or has been deleted;
9595 `deleted` is true only for deleted accounts.
9696
97 - `type: "user_actor"`
97 - `BetaSpendLimitScopedAPIKeyActor object`
9898
99 Actor type. Always `user_actor`.
100
101 default: user_actor
102
103 - `deleted: boolean`
104
105 True only when the underlying account has been deleted.
106
107 default: false
108
109 - `email_address: string or null`
110
111 The user's email address. Null when the account is unavailable or has been deleted.
112
113 - `name: string or null`
114
115 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
116
117 - `user_id: string`
118
119 Tagged ID of the user.
120
121 - `ScopedAPIKeyActor object`
122
12399 A scoped Admin API key acting on behalf of the organization.
124100
125 - `type: "scoped_api_key_actor"`
126
127 default: scoped_api_key_actor
128
129 - `scoped_api_key_id: string`
130
131101 - `spend_summary: BetaSpendSummary or null`
132102
133103 Per-member effective-limit report row (`GET /spend_limits/effective`).
134104
135 - `actor: UserActor or ScopedAPIKeyActor`
105 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`
136106
137 - `UserActor object`
107 - `BetaSpendLimitUserActor object`
138108
139109 A user within the organization. `name` and `email_address` are
140110 null when the underlying account is unavailable or has been deleted;
141111 `deleted` is true only for deleted accounts.
142112
143 - `type: "user_actor"`
113 - `BetaSpendLimitScopedAPIKeyActor object`
144114
145 Actor type. Always `user_actor`.
146
147 default: user_actor
148
149 - `deleted: boolean`
150
151 True only when the underlying account has been deleted.
152
153 default: false
154
155 - `email_address: string or null`
156
157 The user's email address. Null when the account is unavailable or has been deleted.
158
159 - `name: string or null`
160
161 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
162
163 - `user_id: string`
164
165 Tagged ID of the user.
166
167 - `ScopedAPIKeyActor object`
168
169115 A scoped Admin API key acting on behalf of the organization.
170116
171 - `type: "scoped_api_key_actor"`
172
173 default: scoped_api_key_actor
174
175 - `scoped_api_key_id: string`
176
177117 - `amount: string or null`
178118
179119 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.
from line 130
190130
191131 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.
192132
193 - `scope: User or SeatTier or RBACGroup or 3 more`
133 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
194134
195 - `User object`
135 - `BetaSpendLimitUserScope object`
196136
197137 Scope selecting a single member of the organization.
198138
from line 146
206146
207147 Tagged ID of the member the spend limit applies to.
208148
209 - `SeatTier object`
149 - `BetaSpendLimitSeatTierScope object`
210150
211151 - `type: "seat_tier"`
212152
from line 154
214154
215155 - `seat_tier: string`
216156
217 - `RBACGroup object`
157 - `BetaSpendLimitRBACGroupScope object`
218158
219159 - `type: "rbac_group"`
220160
from line 162
222162
223163 - `rbac_group_id: string`
224164
225 - `OrganizationService object`
165 - `BetaSpendLimitOrganizationServiceScope object`
226166
227167 - `type: "organization_service"`
228168
from line 170
230170
231171 - `service: string`
232172
233 - `Organization object`
173 - `BetaSpendLimitOrganizationScope object`
234174
235175 - `type: "organization"`
236176
237177 default: organization
238178
239 - `Workspace object`
179 - `BetaSpendLimitWorkspaceScope object`
240180
241181 Scope selecting one workspace of a Claude Console organization.
242182
from line 190
250190
251191 Tagged ID of the workspace the spend limit applies to.
252192
253 - `source: User or SeatTier or RBACGroup or 3 more`
193 - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
254194
255 - `User object`
195 - `BetaSpendLimitUserScope object`
256196
257197 Scope selecting a single member of the organization.
258198
259 - `type: "user"`
199 - `BetaSpendLimitSeatTierScope object`
260200
261 Scope type. Always `user` for this scope.
201 - `BetaSpendLimitRBACGroupScope object`
262202
263 default: user
203 - `BetaSpendLimitOrganizationServiceScope object`
264204
265 - `user_id: string`
205 - `BetaSpendLimitOrganizationScope object`
266206
267 Tagged ID of the member the spend limit applies to.
207 - `BetaSpendLimitWorkspaceScope object`
268208
269 - `SeatTier object`
270
271 - `type: "seat_tier"`
272
273 default: seat_tier
274
275 - `seat_tier: string`
276
277 - `RBACGroup object`
278
279 - `type: "rbac_group"`
280
281 default: rbac_group
282
283 - `rbac_group_id: string`
284
285 - `OrganizationService object`
286
287 - `type: "organization_service"`
288
289 default: organization_service
290
291 - `service: string`
292
293 - `Organization object`
294
295 - `type: "organization"`
296
297 default: organization
298
299 - `Workspace object`
300
301209 Scope selecting one workspace of a Claude Console organization.
302
303 - `type: "workspace"`
304
305 Scope type. Always `workspace` for this scope.
306
307 default: workspace
308
309 - `workspace_id: string`
310
311 Tagged ID of the workspace the spend limit applies to.
312210
313211 - `spend_limit_id: string`
314212
api/beta/organization/spend_limits/list New page · 299 lines, new page
# List Spend Limits ## Query parameters ## Headers ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List Spend Limits
url: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list
---
# List Spend Limits
**GET** `/v1/organizations/spend_limits`
List the organization's spend limits.
A Claude Console organization's limits come in an order that is stable across
pages. A Claude Enterprise organization's 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.
## Query parameters
- `limit: optional number`
Maximum number of limits per page. Defaults to `20`.
default: 20, minimum: 1, maximum: 1000
- `page: optional string`
Opaque cursor from a previous response's `next_page` field.
- `scope_type: optional array of "organization" or "organization_service" or "rbac_group" or 3 more`
Return only limits with these scope types. A Claude Console organization has `organization` and `workspace` limits; a Claude Enterprise organization has `organization`, `seat_tier`, `rbac_group`, `organization_service` and `user` limits. Omit for all.
maxItems: 6
- `"organization"`
- `"organization_service"`
- `"rbac_group"`
- `"seat_tier"`
- `"user"`
- `"workspace"`
## Headers
- `"anthropic-beta": optional array of AnthropicBeta`
This endpoint is in beta: requests must send `spend-limit-reads-2026-09-26` in this header.
- `string`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"user-profiles-2026-08-18"`
- `"user-profiles-2026-09-04"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
- `"compact-2026-01-12"`
- `"computer-use-2025-11-24"`
- `"mcp-tunnels-2026-06-22"`
- `"structured-outputs-2025-11-13"`
- `"task-budgets-2026-03-13"`
- `"thinking-display-updates-2026-08-18"`
- `"ce-user-management-2026-07-13"`
- `"mid-conversation-output-config-2026-07-01"`
- `"thinking-binding-controls-2026-08-01"`
- `"mid-conversation-system-clear-at-2026-08-21"`
- `"compact-2026-09-04"`
- `"inline-tools-2026-09-15"`
- `"mcp-client-2026-09-15"`
- `"ce-plugins-2026-09-01"`
- `"spend-limit-reads-2026-09-26"`
## Returns
- `data: array of BetaSpendLimit`
- `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
- `next_page: string or null`
## Example
```bash
curl https://api.anthropic.com/v1/organizations/spend_limits \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: spend-limit-reads-2026-09-26' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
### 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"
}
```
api/beta/organization/spend_limits/list_effective Page removed · 276 lines, page removed
# List Effective Spend Limits ## Query parameters ## Returns ## Example ### Response (200)
The page is gone upstream. What it last said is kept here.
api/beta/organization/spend_limits/retrieve Changed · +12 / -7 lines
from line 45
4545
4646 ISO 4217 code of the organization's billing currency; the unit for `amount`.
4747
48 - `is_enabled: boolean`
49
50 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.
51
4852 - `period: BetaSpendLimitPeriod`
4953
5054 Length of the window the limit resets over. `amount` caps spend within each period.
from line 59
5559
5660 - `"weekly"`
5761
58 - `scope: User or SeatTier or RBACGroup or 3 more`
62 - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 3 more`
5963
6064 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
6165
62 - `User object`
66 - `BetaSpendLimitUserScope object`
6367
6468 Scope selecting a single member of the organization.
6569
from line 77
7377
7478 Tagged ID of the member the spend limit applies to.
7579
76 - `SeatTier object`
80 - `BetaSpendLimitSeatTierScope object`
7781
7882 - `type: "seat_tier"`
7983
from line 85
8185
8286 - `seat_tier: string`
8387
84 - `RBACGroup object`
88 - `BetaSpendLimitRBACGroupScope object`
8589
8690 - `type: "rbac_group"`
8791
from line 93
8993
9094 - `rbac_group_id: string`
9195
92 - `OrganizationService object`
96 - `BetaSpendLimitOrganizationServiceScope object`
9397
9498 - `type: "organization_service"`
9599
from line 101
97101
98102 - `service: string`
99103
100 - `Organization object`
104 - `BetaSpendLimitOrganizationScope object`
101105
102106 - `type: "organization"`
103107
104108 default: organization
105109
106 - `Workspace object`
110 - `BetaSpendLimitWorkspaceScope object`
107111
108112 Scope selecting one workspace of a Claude Console organization.
109113
from line 143
139143 "amount": "50000",
140144 "created_at": "2019-12-27T18:11:19.117Z",
141145 "currency": "USD",
146 "is_enabled": true,
142147 "period": "daily",
143148 "scope": {
144149 "type": "user",