What this read moved
1–25 of 72This capture is too large to show at once. Changes 1-25 of 72 are below, significant first; the rest are on the following screens.
about-claude/model-deprecations Changed · +4 / -1 lines
from line 71
7171Current and recently retired models are listed in the following table with their status:
7272
7373| API model name | Current state | Deprecated | Tentative retirement date |
74| -------------------------- | ------------- | ----------------- | ---------------------------------- |
74| :------------------------- | :------------ | :---------------- | :--------------------------------- |
7575| claude-fable-5-1 | Active | N/A | Not sooner than September 1, 2027 |
76| claude-mythos-5-1 | Active | N/A | Not sooner than September 1, 2027 |
7677| claude-fable-5 | Active | N/A | Not sooner than June 9, 2027 |
78| claude-mythos-5 | Active | N/A | Not sooner than June 9, 2027 |
79| claude-mythos-preview | Deprecated | June 9, 2026 | To be announced |
7780| claude-opus-5 | Active | N/A | Not sooner than July 24, 2027 |
7881| claude-opus-4-8 | Active | N/A | Not sooner than May 28, 2027 |
7982| claude-opus-4-7 | Active | N/A | Not sooner than April 16, 2027 |
api/beta Changed · +702 / -261 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 2499
24992499
25002500 - `BetaToolChangeMCPToolReference object`
25012501
2502 Reference to a single MCP tool by its server and remote name — the
2502 Reference to a single MCP tool by its server and remote name; the
25032503 same `server_name`/`name` pair `mcp_tool_use` carries.
25042504
25052505 - `type: "mcp_tool_reference"`
from line 2541
25412541
25422542 - `BetaToolChangeMCPToolReference object`
25432543
2544 Reference to a single MCP tool by its server and remote name — the
2544 Reference to a single MCP tool by its server and remote name; the
25452545 same `server_name`/`name` pair `mcp_tool_use` carries.
25462546
25472547 - `BetaToolChangeMCPToolsetReference object`
from line 8755
87558755
87568756 - `type: "tool_addition"`
87578757
8758 - `tool: BetaToolC
8758 - `tool: BetaToolChangeT
api/beta/messages Changed · +13 / -13 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 1318
13181318
13191319 - `BetaToolChangeMCPToolReference object`
13201320
1321 Reference to a single MCP tool by its server and remote name — the
1321 Reference to a single MCP tool by its server and remote name; the
13221322 same `server_name`/`name` pair `mcp_tool_use` carries.
13231323
13241324 - `type: "mcp_tool_reference"`
from line 1360
13601360
13611361 - `BetaToolChangeMCPToolReference object`
13621362
1363 Reference to a single MCP tool by its server and remote name — the
1363 Reference to a single MCP tool by its server and remote name; the
13641364 same `server_name`/`name` pair `mcp_tool_use` carries.
13651365
13661366 - `BetaToolChangeMCPToolsetReference object`
from line 7591
75917591
75927592 - `BetaToolChangeMCPToolReference object`
75937593
7594 Reference to a single MCP tool by its server and remote name — the
7594 Reference to a single MCP tool by its server and remote name; the
75957595 same `server_name`/`name` pair `mcp_tool_use` carries.
75967596
75977597 - `type: "mcp_tool_reference"`
from line 7633
76337633
76347634 - `BetaToolChangeMCPToolReference object`
76357635
7636 Reference to a single MCP tool by its server and remote name — the
7636 Reference to a single MCP tool by its server and remote name; the
76377637 same `server_name`/`name` pair `mcp_tool_use` carries.
76387638
76397639 - `BetaToolChangeMCPToolsetReference object`
from line 8335
83358335
83368336 - `defer_loading: optional boolean`
83378337
8338 If true, tool will not be included in initial system prompt. Only loaded when returned via too
8338 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference
api/beta/organization Changed · +694 / -253 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
Nothing in the body moved in this read. What changed is above.
api/beta/organization/mcp_tunnels Changed · +18 / -9 lines
from line 48
4848
4949- `"anthropic-beta": array of AnthropicBeta`
5050
51 Optional header to specify the beta version(s) you want to use.
51 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
5252
5353 - `string`
5454
from line 197
197197```bash
198198curl https://api.anthropic.com/v1/organizations/tunnels \
199199 -H 'anthropic-version: 2023-06-01' \
200 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
200201 -H "X-Api-Key: $ANTHROPIC_API_KEY"
201202```
202203
from line 240
239240
240241- `"anthropic-beta": array of AnthropicBeta`
241242
242 Optional header to specify the beta version(s) you want to use.
243 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
243244
244245 - `string`
245246
from line 385
384385```bash
385386curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID \
386387 -H 'anthropic-version: 2023-06-01' \
388 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
387389 -H "X-Api-Key: $ANTHROPIC_API_KEY"
388390```
389391
from line 428
426428
427429- `"anthropic-beta": array of AnthropicBeta`
428430
429 Optional header to specify the beta version(s) you want to use.
431 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
430432
431433 - `string`
432434
from line 574
572574curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/archive \
573575 -X POST \
574576 -H 'anthropic-version: 2023-06-01' \
577 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
575578 -H "X-Api-Key: $ANTHROPIC_API_KEY"
576579```
577580
from line 617
614617
615618- `"anthropic-beta": array of AnthropicBeta`
616619
617 Optional header to specify the beta version(s) you want to use.
620 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
618621
619622 - `string`
620623
from line 740
737740curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/reveal_token \
738741 -X POST \
739742 -H 'anthropic-version: 2023-06-01' \
743 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
740744 -H "X-Api-Key: $ANTHROPIC_API_KEY"
741745```
742746
from line 778
774778
775779- `"anthropic-beta": array of AnthropicBeta`
776780
777 Optional header to specify the beta version(s) you want to use.
781 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
778782
779783 - `string`
780784
from line 909
905909curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/rotate_token \
906910 -X POST \
907911 -H 'anthropic-version: 2023-06-01' \
912 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
908913 -H "X-Api-Key: $ANTHROPIC_API_KEY"
909914```
910915
from line 1013
10081013
10091014- `"anthropic-beta": array of AnthropicBeta`
10101015
1011 Optional header to specify the beta version(s) you want to use.
1016 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
10121017
10131018 - `string`
10141019
from line 1168
11631168curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
11641169 -H 'Content-Type: application/json' \
11651170 -H 'anthropic-version: 2023-06-01' \
1171 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
11661172 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
11671173 -d '{
11681174 "ca_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\n...illustrative placeholder, not a real certificate...\n-----END CERTIFICATE-----\n"
from line 1231
12251231
12261232- `"anthropic-beta": array of AnthropicBeta`
12271233
1228 Optional header to specify the beta version(s) you want to use.
1234 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
12291235
12301236 - `string`
12311237
from line 1380
13741380```bash
13751381curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
13761382 -H 'anthropic-version: 2023-06-01' \
1383 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
13771384 -H "X-Api-Key: $ANTHROPIC_API_KEY"
13781385```
13791386
from line 1427
14201427
14211428- `"anthropic-beta": array of AnthropicBeta`
14221429
1423 Optional header to specify the beta version(s) you want to use.
1430 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
14241431
14251432 - `string`
14261433
from line 1572
15651572```bash
15661573curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
15671574 -H 'anthropic-version: 2023-06-01' \
1575 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
15681576 -H "X-Api-Key: $ANTHROPIC_API_KEY"
15691577```
15701578
from line 1618
16101618
16111619- `"anthropic-beta": array of AnthropicBeta`
16121620
1613 Optional header to specify the beta version(s) you want to use.
1621 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
16141622
16151623 - `string`
16161624
from line 1764
17561764curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
17571765 -X POST \
17581766 -H 'anthropic-version: 2023-06-01' \
1767 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
17591768 -H "X-Api-Key: $ANTHROPIC_API_KEY"
17601769```
17611770
api/beta/organization/mcp_tunnels/tunnel_certificates Changed · +8 / -4 lines
from line 30
3030
3131- `"anthropic-beta": array of AnthropicBeta`
3232
33 Optional header to specify the beta version(s) you want to use.
33 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
3434
3535 - `string`
3636
from line 185
185185curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
186186 -H 'Content-Type: application/json' \
187187 -H 'anthropic-version: 2023-06-01' \
188 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
188189 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
189190 -d '{
190191 "ca_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\n...illustrative placeholder, not a real certificate...\n-----END CERTIFICATE-----\n"
from line 248
247248
248249- `"anthropic-beta": array of AnthropicBeta`
249250
250 Optional header to specify the beta version(s) you want to use.
251 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
251252
252253 - `string`
253254
from line 397
396397```bash
397398curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \
398399 -H 'anthropic-version: 2023-06-01' \
400 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
399401 -H "X-Api-Key: $ANTHROPIC_API_KEY"
400402```
401403
from line 444
442444
443445- `"anthropic-beta": array of AnthropicBeta`
444446
445 Optional header to specify the beta version(s) you want to use.
447 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
446448
447449 - `string`
448450
from line 589
587589```bash
588590curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \
589591 -H 'anthropic-version: 2023-06-01' \
592 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
590593 -H "X-Api-Key: $ANTHROPIC_API_KEY"
591594```
592595
from line 635
632635
633636- `"anthropic-beta": array of AnthropicBeta`
634637
635 Optional header to specify the beta version(s) you want to use.
638 This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header.
636639
637640 - `string`
638641
from line 781
778781curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \
779782 -X POST \
780783 -H 'anthropic-version: 2023-06-01' \
784 -H 'anthropic-beta: mcp-tunnels-2026-05-19' \
781785 -H "X-Api-Key: $ANTHROPIC_API_KEY"
782786```
783787
api/beta/organization/spend_limits Changed · +932 / -414 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 9
99
1010**POST** `/v1/organizations/spend_limits`
1111
12Set a per-user spend limit override.
12Set a spend limit.
1313
1414Upsert keyed on (scope, period): setting a limit that already exists
15overwrites it in place. Only `scope.type: "user"` is accepted; seat-tier,
16group, and organization-level defaults are configured in claude.ai.
15overwrites it in place. A Claude Enterprise organization sets `user`
16limits. Its seat-tier, group, and organization-level defaults are configured
17in claude.ai. A Claude Console organization sets `organization` and
18`workspace` limits, which are monthly and always carry an amount. Setting those
19limits is in an early access preview. To request access, contact your
20Anthropic account team.
1721
1822### Body parameters
1923
from line 25
2125
2226 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.
2327
24- `scope: object`
25
26 Scope selecting a single member of the organization.
27
28 - `type: "user"`
29
30 Scope type. Always `user` for this scope.
31
32 default: user
33
34 - `user_id: string`
35
36 Tagged ID of the member the spend limit applies to.
28- `scope: User or Organization or Workspace`
29
30 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.
31
32 - `User object`
33
34 Scope selecting a single member of the organization.
35
36 - `type: "user"`
37
38 Scope type. Always `user` for this scope.
39
40 default: user
41
42 - `user_id: string`
43
44 Tagged ID of the member the spend limit applies to.
45
46 - `Organization object`
47
48 - `type: "organization"`
49
50 default: organization
51
52 - `Workspace object`
53
54 Scope selecting one workspace of a Claude Console organization.
55
56 - `type: "workspace"`
57
58 Scope type. Always `workspace` for this scope.
59
60 default: workspace
61
62 - `workspace_id: string`
63
64 Tagged ID of the workspace the spend limit applies to.
3765
3866- `period: optional "daily" or "monthly" or "weekly"`
3967
from line 111
83111
84112 - `"weekly"`
85113
86 - `scope: User or SeatTier or RBACGroup or 2 more`
114 - `scope: User or SeatTier or RBACGroup or 3 more`
87115
88116 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
89117
from line 158
130158 - `type: "organization"`
131159
132160 default: organization
161
162 - `Workspace object`
163
164 Scope selecting one workspace of a Claude Console organization.
165
166 - `type: "workspace"`
167
168 Scope type. Always `workspace` for this scope.
169
170 default: workspace
171
172 - `workspace_id: string`
173
174 Tagged ID of the workspace the spend limit applies to.
133175
134176 - `updated_at: string`
135177
from line 266
224266
225267 - `"weekly"`
226268
227 - `scope: User or SeatTier or RBACGroup or 2 more`
269 - `scope: User or SeatTier or RBACGroup or 3 more`
228270
229271 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
230272
from line 313
271313 - `type: "organization"`
272314
273315 default: organization
316
317 - `Workspace object`
318
319 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.
274330
275331 - `updated_at: string`
276332
from line 364
308364
309365**DELETE** `/v1/organizations/spend_limits/{spend_limit_id}`
310366
311Delete a per-user spend limit override.
312
313The member falls back to any inherited spend limit at that period.
314Seat-tier, group, and organization-level rows cannot be deleted via
315this endpoint.
367Delete a spend limit.
368
369For a Claude Enterprise organization, this deletes a per-user override, and
370the member falls back to any inherited spend limit at that period. Its
371seat-tier, group, and organization-level rows cannot be deleted via this
372endpoint. A Claude Console organization deletes its organization and
373workspace limits. Deleting them through the API is in an early access preview.
316374
317375### Path parameters
318376
from line 448
390448
391449- `data: array of BetaSpendSummary`
392450
393 - `actor: object`
394
395 A user within the organization. `name` and `email_address` are
396 null when the underlying account is unavailable or has been deleted;
397 `deleted` is true only for deleted accounts.
398
399 - `type: "user_actor"`
400
401 Actor type. Always `user_actor`.
402
403 default: user_actor
404
405 - `deleted: boolean`
406
407 True only when the underlying account has been deleted.
408
409 default: false
410
411 - `email_address: string or null`
412
413 The user's email address. Null when the account is unavailable or has been deleted.
414
415 - `name: string or null`
416
417 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
418
419 - `user_id: string`
420
421 Tagged ID of the user.
451 - `actor: UserActor or ScopedAPIKeyActor`
452
453 - `UserActor object`
454
455 A user within the organization. `name` and `email_address` are
456 null when the underlying account is unavailable or has been deleted;
457 `deleted` is true only for deleted accounts.
458
459 - `type: "user_actor"`
460
461 Actor type. Always `user_actor`.
462
463 default: user_actor
464
465 - `deleted: boolean`
466
467 True only when the underlying account has been deleted.
468
469 default: false
470
471 - `email_address: string or null`
472
473 The user's email address. Null when the account is unavailable or has been deleted.
474
475 - `name: string or null`
476
477 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
478
479 - `user_id: string`
480
481 Tagged ID of the user.
482
483 - `ScopedAPIKeyActor object`
484
485 A scoped Admin API key acting on behalf of the organization.
486
487 - `type: "scoped_api_key_actor"`
488
489 default: scoped_api_key_actor
490
491 - `scoped_api_key_id: string`
422492
423493 - `amount: string or null`
424494
from line 512
442512
443513 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.
444514
445 - `scope: object`
446
447 Scope selecting a single member of the organization.
448
449 - `type: "user"`
450
451 Scope type. Always `user` for this scope.
452
453 default: user
454
455 - `user_id: string`
456
457 Tagged ID of the member the spend limit applies to.
458
459 - `source: User or SeatTier or RBACGroup or 2 more`
515 - `scope: User or SeatTier or RBACGroup or 3 more`
460516
461517 - `User object`
462518
from line 557
501557 - `type: "organization"`
502558
503559 default: organization
560
561 - `Workspace object`
562
563 Scope selecting one workspace of a Claude Console organization.
564
565 - `type: "workspace"`
566
567 Scope type. Always `workspace` for this scope.
568
569 default: workspace
570
571 - `workspace_id: string`
572
573 Tagged ID of the workspace the spend limit applies to.
574
575 - `source: User or SeatTier or RBACGroup or 3 more`
576
577 - `User object`
578
579 Scope selecting a single member of the organization.
580
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`
622
623 Scope selecting one workspace of a Claude Console organization.
624
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.
504634
505635 - `spend_limit_id: string`
506636
from line 718
588718
589719 - `"weekly"`
590720
591 - `scope: User or SeatTier or RBACGroup or 2 more`
721 - `scope: User or SeatTier or RBACGroup or 3 more`
592722
593723 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
594724
from line 766
636766
637767 default: organization
638768
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
639783 - `updated_at: string`
640784
641785 RFC 3339 datetime at which the spend limit was last modified.
from line 791
647791- `BetaSpendSummary object`
648792
649793 Per-member effective-limit report row (`GET /spend_limits/effective`).
794
795 - `actor: UserActor or ScopedAPIKeyActor`
796
797 - `UserActor object`
798
799 A user within the organization. `name` and `email_address` are
800 null when the underlying account is unavailable or has been deleted;
801 `deleted` is true only for deleted accounts.
802
803 - `type: "user_actor"`
804
805 Actor type. Always `user_actor`.
806
807 default: user_actor
808
809 - `deleted: boolean`
810
811 True only when the underlying account has been deleted.
812
813 default: false
814
815 - `email_address: string or null`
816
817 The user's email address. Null when the account is unavailable or has been deleted.
818
819 - `name: string or null`
820
821 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
822
823 - `user_id: string`
824
825 Tagged ID of the user.
826
827 - `ScopedAPIKeyActor object`
828
829 A scoped Admin API key acting on behalf of the organization.
830
831 - `type: "scoped_api_key_actor"`
832
833 default: scoped_api_key_actor
834
835 - `scoped_api_key_id: string`
836
837 - `amount: string or null`
838
839 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.
840
841 - `currency: string`
842
843 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
844
845 - `period: "daily" or "monthly" or "weekly"`
846
847 Period this row's effective limit and spend are reported for.
848
849 - `"daily"`
850
851 - `"monthly"`
852
853 - `"weekly"`
854
855 - `period_to_date_spend: string`
856
857 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.
858
859 - `scope: User or SeatTier or RBACGroup or 3 more`
860
861 - `User object`
862
863 Scope selecting a single member of the organization.
864
865 - `type: "user"`
866
867 Scope type. Always `user` for this scope.
868
869 default: user
870
871 - `user_id: string`
872
873 Tagged ID of the member the spend limit applies to.
874
875 - `SeatTier object`
876
877 - `type: "seat_tier"`
878
879 default: seat_tier
880
881 - `seat_tier: string`
882
883 - `RBACGroup object`
884
885 - `type: "rbac_group"`
886
887 default: rbac_group
888
889 - `rbac_group_id: string`
890
891 - `OrganizationService object`
892
893 - `type: "organization_service"`
894
895 default: organization_service
896
897 - `service: string`
898
899 - `Organization object`
900
901 - `type: "organization"`
902
903 default: organization
904
905 - `Workspace object`
906
907 Scope selecting one workspace of a Claude Console organization.
908
909 - `type: "workspace"`
910
911 Scope type. Always `workspace` for this scope.
912
913 default: workspace
914
915 - `workspace_id: string`
916
917 Tagged ID of the workspace the spend limit applies to.
918
919 - `source: User or SeatTier or RBACGroup or 3 more`
920
921 - `User object`
922
923 Scope selecting a single member of the organization.
924
925 - `type: "user"`
926
927 Scope type. Always `user` for this scope.
928
929 default: user
930
931 - `user_id: string`
932
933 Tagged ID of the member the spend limit applies to.
934
935 - `SeatTier object`
936
937 - `type: "seat_tier"`
938
939 default: seat_tier
940
941 - `seat_tier: string`
942
943 - `RBACGroup object`
944
945 - `type: "rbac_group"`
946
947 default: rbac_group
948
949 - `rbac_group_id: string`
950
951 - `OrganizationService object`
952
953 - `type: "organization_service"`
954
955 default: organization_service
956
957 - `service: string`
958
959 - `Organization object`
960
961 - `type: "organization"`
962
963 default: organization
964
965 - `Workspace object`
966
967 Scope selecting one workspace of a Claude Console organization.
968
969 - `type: "workspace"`
970
971 Scope type. Always `workspace` for this scope.
972
973 default: workspace
974
975 - `workspace_id: string`
976
977 Tagged ID of the workspace the spend limit applies to.
978
979 - `spend_limit_id: string`
980
981### Spend Limit Delete Response
982
983- `SpendLimitDeleteResponse object`
984
985 - `type: "spend_limit_deleted"`
986
987 default: spend_limit_deleted
988
989 - `id: string`
990
991## Spend Limits › Increase Requests
992
993### List Spend Limit Increase Requests
994
995**GET** `/v1/organizations/spend_limit_increase_requests`
996
997List spend limit increase requests, most recent first.
998
999Pending requests include a live `spend_summary` for the requester.
1000Requests whose requester is no longer a member are excluded.
1001
1002#### Query parameters
1003
1004- `actor_ids: optional array of string`
1005
1006 Filter by requester, as `user_...` tagged IDs.
1007
1008- `limit: optional number`
1009
1010 default: 20, maximum: 1000, minimum: 1
1011
1012- `page: optional string`
1013
1014 Opaque cursor from a previous response's `next_page`.
1015
1016- `status: optional array of "approved" or "denied" or "pending"`
1017
1018 Filter by status. Omit to return all.
1019
1020 - `"approved"`
1021
1022 - `"denied"`
1023
1024 - `"pending"`
1025
1026#### Returns
1027
1028- `data: array of BetaSpendLimitIncreaseRequest`
1029
1030 - `type: "spend_limit_increase_request"`
1031
1032 default: spend_limit_increase_request
1033
1034 - `id: string`
6501035
6511036 - `actor: object`
6521037
from line 1063
6781063
6791064 Tagged ID of the user.
6801065
681 - `amount: string or null`
682
683 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.
684
685 - `currency: string`
686
687 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
688
689 - `period: "daily" or "monthly" or "weekly"`
690
691 Period this row's effective limit and spend are reported for.
692
693 - `"daily"`
694
695 - `"monthly"`
696
697 - `"weekly"`
698
699 - `period_to_date_spend: string`
700
701 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.
702
703 - `scope: object`
704
705 Scope selecting a single member of the organization.
706
707 - `type: "user"`
708
709 Scope type. Always `user` for this scope.
710
711 default: user
712
713 - `user_id: string`
714
715 Tagged ID of the member the spend limit applies to.
716
717 - `source: User or SeatTier or RBACGroup or 2 more`
718
719 - `User object`
720
721 Scope selecting a single member of the organization.
722
723 - `type: "user"`
724
725 Scope type. Always `user` for this scope.
726
727 default: user
728
729 - `user_id: string`
730
731 Tagged ID of the member the spend limit applies to.
732
733 - `SeatTier object`
734
735 - `type: "seat_tier"`
736
737 default: seat_tier
738
739 - `seat_tier: string`
740
741 - `RBACGroup object`
742
743 - `type: "rbac_group"`
744
745 default: rbac_group
746
747 - `rbac_group_id: string`
748
749 - `OrganizationService object`
750
751 - `type: "organization_service"`
752
753 default: organization_service
754
755 - `service: string`
756
757 - `Organization object`
758
759 - `type: "organization"`
760
761 default: organization
762
763 - `spend_limit_id: string`
764
765### Spend Limit Delete Response
766
767- `SpendLimitDeleteResponse object`
768
769 - `type: "spend_limit_deleted"`
770
771 default: spend_limit_deleted
772
773 - `id: string`
774
775## Spend Limits › Increase Requests
776
777### List Spend Limit Increase Requests
778
779**GET** `/v1/organizations/spend_limit_increase_requests`
780
781List spend limit increase requests, most recent first.
782
783Pending requests include a live `spend_summary` for the requester.
784Requests whose requester is no longer a member are excluded.
785
786#### Query parameters
787
788- `actor_ids: optional array of string`
789
790 Filter by requester, as `user_...` tagged IDs.
791
792- `limit: optional number`
793
794 default: 20, maximum: 1000, minimum: 1
795
796- `page: optional string`
797
798 Opaque cursor from a previous response's `next_page`.
799
800- `status: optional array of "approved" or "denied" or "pending"`
801
802 Filter by status. Omit to return all.
803
804 - `"approved"`
805
806 - `"denied"`
807
808 - `"pending"`
809
810#### Returns
811
812- `data: array of BetaSpendLimitIncreaseRequest`
813
814 - `type: "spend_limit_increase_request"`
815
816 default: spend_limit_increase_request
817
818 - `id: string`
819
820 - `actor: object`
821
822 A user within the organization. `name` and `email_address` are
823 null when the underlying account is unavailable or has been deleted;
824 `deleted` is true only for deleted accounts.
825
826 - `type: "user_actor"`
827
828 Actor type. Always `user_actor`.
829
830 default: user_actor
831
832 - `deleted: boolean`
833
834 True only when the underlying account has been deleted.
835
836 default: false
837
838 - `email_address: string or null`
839
840 The user's email address. Null when the account is unavailable or has been deleted.
841
842 - `name: string or null`
843
844 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
845
846 - `user_id: string`
847
848 Tagged ID of the user.
849
8501066 - `created_at: string`
8511067
8521068 format: date-time
from line 1125
9091125
9101126 Per-member effective-limit report row (`GET /spend_limits/effective`).
9111127
912 - `actor: object`
913
914 A user within the organization. `name` and `email_address` are
915 null when the underlying account is unavailable or has been deleted;
916 `deleted` is true only for deleted accounts.
917
918 - `type: "user_actor"`
919
920 Actor type. Always `user_actor`.
921
922 default: user_actor
923
924 - `deleted: boolean`
925
926 True only when the underlying account has been deleted.
927
928 default: false
929
930 - `email_address: string or null`
931
932 The user's email address. Null when the account is unavailable or has been deleted.
933
934 - `name: string or null`
935
936 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
937
938 - `user_id: string`
939
940 Tagged ID of the user.
1128 - `actor: UserActor or ScopedAPIKeyActor`
1129
1130 - `UserActor object`
1131
1132 A user within the organization. `name` and `email_address` are
1133 null when the underlying account is unavailable or has been deleted;
1134 `deleted` is true only for deleted accounts.
1135
1136 - `type: "user_actor"`
1137
1138 Actor type. Always `user_actor`.
1139
1140 default: user_actor
1141
1142 - `deleted: boolean`
1143
1144 True only when the underlying account has been deleted.
1145
1146 default: false
1147
1148 - `email_address: string or null`
1149
1150 The user's email address. Null when the account is unavailable or has been deleted.
1151
1152 - `name: string or null`
1153
1154 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1155
1156 - `user_id: string`
1157
1158 Tagged ID of the user.
1159
1160 - `ScopedAPIKeyActor object`
1161
1162 A scoped Admin API key acting on behalf of the organization.
1163
1164 - `type: "scoped_api_key_actor"`
1165
1166 default: scoped_api_key_actor
1167
1168 - `scoped_api_key_id: string`
9411169
9421170 - `amount: string or null`
9431171
from line 1189
9611189
9621190 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.
9631191
964 - `scope: object`
965
966 Scope selecting a single member of the organization.
967
968 - `type: "user"`
969
970 Scope type. Always `user` for this scope.
971
972 default: user
973
974 - `user_id: string`
975
976 Tagged ID of the member the spend limit applies to.
977
978 - `source: User or SeatTier or RBACGroup or 2 more`
1192 - `scope: User or SeatTier or RBACGroup or 3 more`
9791193
9801194 - `User object`
9811195
from line 1234
10201234 - `type: "organization"`
10211235
10221236 default: organization
1237
1238 - `Workspace object`
1239
1240 Scope selecting one workspace of a Claude Console organization.
1241
1242 - `type: "workspace"`
1243
1244 Scope type. Always `workspace` for this scope.
1245
1246 default: workspace
1247
1248 - `workspace_id: string`
1249
1250 Tagged ID of the workspace the spend limit applies to.
1251
1252 - `source: User or SeatTier or RBACGroup or 3 more`
1253
1254 - `User object`
1255
1256 Scope selecting a single member of the organization.
1257
1258 - `type: "user"`
1259
1260 Scope type. Always `user` for this scope.
1261
1262 default: user
1263
1264 - `user_id: string`
1265
1266 Tagged ID of the member the spend limit applies to.
1267
1268 - `SeatTier object`
1269
1270 - `type: "seat_tier"`
1271
1272 default: seat_tier
1273
1274 - `seat_tier: string`
1275
1276 - `RBACGroup object`
1277
1278 - `type: "rbac_group"`
1279
1280 default: rbac_group
1281
1282 - `rbac_group_id: string`
1283
1284 - `OrganizationService object`
1285
1286 - `type: "organization_service"`
1287
1288 default: organization_service
1289
1290 - `service: string`
1291
1292 - `Organization object`
1293
1294 - `type: "organization"`
1295
1296 default: organization
1297
1298 - `Workspace object`
1299
1300 Scope selecting one workspace of a Claude Console organization.
1301
1302 - `type: "workspace"`
1303
1304 Scope type. Always `workspace` for this scope.
1305
1306 default: workspace
1307
1308 - `workspace_id: string`
1309
1310 Tagged ID of the workspace the spend limit applies to.
10231311
10241312 - `spend_limit_id: string`
10251313
from line 1500
12121500
12131501 Per-member effective-limit report row (`GET /spend_limits/effective`).
12141502
1215 - `actor: object`
1216
1217 A user within the organization. `name` and `email_address` are
1218 null when the underlying account is unavailable or has been deleted;
1219 `deleted` is true only for deleted accounts.
1220
1221 - `type: "user_actor"`
1222
1223 Actor type. Always `user_actor`.
1224
1225 default: user_actor
1226
1227 - `deleted: boolean`
1228
1229 True only when the underlying account has been deleted.
1230
1231 default: false
1232
1233 - `email_address: string or null`
1234
1235 The user's email address. Null when the account is unavailable or has been deleted.
1236
1237 - `name: string or null`
1238
1239 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1240
1241 - `user_id: string`
1242
1243 Tagged ID of the user.
1503 - `actor: UserActor or ScopedAPIKeyActor`
1504
1505 - `UserActor object`
1506
1507 A user within the organization. `name` and `email_address` are
1508 null when the underlying account is unavailable or has been deleted;
1509 `deleted` is true only for deleted accounts.
1510
1511 - `type: "user_actor"`
1512
1513 Actor type. Always `user_actor`.
1514
1515 default: user_actor
1516
1517 - `deleted: boolean`
1518
1519 True only when the underlying account has been deleted.
1520
1521 default: false
1522
1523 - `email_address: string or null`
1524
1525 The user's email address. Null when the account is unavailable or has been deleted.
1526
1527 - `name: string or null`
1528
1529 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1530
1531 - `user_id: string`
1532
1533 Tagged ID of the user.
1534
1535 - `ScopedAPIKeyActor object`
1536
1537 A scoped Admin API key acting on behalf of the organization.
1538
1539 - `type: "scoped_api_key_actor"`
1540
1541 default: scoped_api_key_actor
1542
1543 - `scoped_api_key_id: string`
12441544
12451545 - `amount: string or null`
12461546
from line 1564
12641564
12651565 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.
12661566
1267 - `scope: object`
1268
1269 Scope selecting a single member of the organization.
1270
1271 - `type: "user"`
1272
1273 Scope type. Always `user` for this scope.
1274
1275 default: user
1276
1277 - `user_id: string`
1278
1279 Tagged ID of the member the spend limit applies to.
1280
1281 - `source: User or SeatTier or RBACGroup or 2 more`
1567 - `scope: User or SeatTier or RBACGroup or 3 more`
12821568
12831569 - `User object`
12841570
from line 1609
13231609 - `type: "organization"`
13241610
13251611 default: organization
1612
1613 - `Workspace object`
1614
1615 Scope selecting one workspace of a Claude Console organization.
1616
1617 - `type: "workspace"`
1618
1619 Scope type. Always `workspace` for this scope.
1620
1621 default: workspace
1622
1623 - `workspace_id: string`
1624
1625 Tagged ID of the workspace the spend limit applies to.
1626
1627 - `source: User or SeatTier or RBACGroup or 3 more`
1628
1629 - `User object`
1630
1631 Scope selecting a single member of the organization.
1632
1633 - `type: "user"`
1634
1635 Scope type. Always `user` for this scope.
1636
1637 default: user
1638
1639 - `user_id: string`
1640
1641 Tagged ID of the member the spend limit applies to.
1642
1643 - `SeatTier object`
1644
1645 - `type: "seat_tier"`
1646
1647 default: seat_tier
1648
1649 - `seat_tier: string`
1650
1651 - `RBACGroup object`
1652
1653 - `type: "rbac_group"`
1654
1655 default: rbac_group
1656
1657 - `rbac_group_id: string`
1658
1659 - `OrganizationService object`
1660
1661 - `type: "organization_service"`
1662
1663 default: organization_service
1664
1665 - `service: string`
1666
1667 - `Organization object`
1668
1669 - `type: "organization"`
1670
1671 default: organization
1672
1673 - `Workspace object`
1674
1675 Scope selecting one workspace of a Claude Console organization.
1676
1677 - `type: "workspace"`
1678
1679 Scope type. Always `workspace` for this scope.
1680
1681 default: workspace
1682
1683 - `workspace_id: string`
1684
1685 Tagged ID of the workspace the spend limit applies to.
13261686
13271687 - `spend_limit_id: string`
13281688
from line 1918
15581918
15591919 - `"weekly"`
15601920
1561 - `scope: User or SeatTier or RBACGroup or 2 more`
1921 - `scope: User or SeatTier or RBACGroup or 3 more`
15621922
15631923 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
15641924
from line 1966
16061966
16071967 default: organization
16081968
1969 - `Workspace object`
1970
1971 Scope selecting one workspace of a Claude Console organization.
1972
1973 - `type: "workspace"`
1974
1975 Scope type. Always `workspace` for this scope.
1976
1977 default: workspace
1978
1979 - `workspace_id: string`
1980
1981 Tagged ID of the workspace the spend limit applies to.
1982
16091983 - `updated_at: string`
16101984
16111985 RFC 3339 datetime at which the spend limit was last modified.
from line 1990
16161990
16171991 Per-member effective-limit report row (`GET /spend_limits/effective`).
16181992
1619 - `actor: object`
1620
1621 A user within the organization. `name` and `email_address` are
1622 null when the underlying account is unavailable or has been deleted;
1623 `deleted` is true only for deleted accounts.
1624
1625 - `type: "user_actor"`
1626
1627 Actor type. Always `user_actor`.
1628
1629 default: user_actor
1630
1631 - `deleted: boolean`
1632
1633 True only when the underlying account has been deleted.
1634
1635 default: false
1636
1637 - `email_address: string or null`
1638
1639 The user's email address. Null when the account is unavailable or has been deleted.
1640
1641 - `name: string or null`
1642
1643 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1644
1645 - `user_id: string`
1646
1647 Tagged ID of the user.
1993 - `actor: UserActor or ScopedAPIKeyActor`
1994
1995 - `UserActor object`
1996
1997 A user within the organization. `name` and `email_address` are
1998 null when the underlying account is unavailable or has been deleted;
1999 `deleted` is true only for deleted accounts.
2000
2001 - `type: "user_actor"`
2002
2003 Actor type. Always `user_actor`.
2004
2005 default: user_actor
2006
2007 - `deleted: boolean`
2008
2009 True only when the underlying account has been deleted.
2010
2011 default: false
2012
2013 - `email_address: string or null`
2014
2015 The user's email address. Null when the account is unavailable or has been deleted.
2016
2017 - `name: string or null`
2018
2019 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2020
2021 - `user_id: string`
2022
2023 Tagged ID of the user.
2024
2025 - `ScopedAPIKeyActor object`
2026
2027 A scoped Admin API key acting on behalf of the organization.
2028
2029 - `type: "scoped_api_key_actor"`
2030
2031 default: scoped_api_key_actor
2032
2033 - `scoped_api_key_id: string`
16482034
16492035 - `amount: string or null`
16502036
from line 2054
16682054
16692055 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.
16702056
1671 - `scope: object`
1672
1673 Scope selecting a single member of the organization.
1674
1675 - `type: "user"`
1676
1677 Scope type. Always `user` for this scope.
1678
1679 default: user
1680
1681 - `user_id: string`
1682
1683 Tagged ID of the member the spend limit applies to.
1684
1685 - `source: User or SeatTier or RBACGroup or 2 more`
2057 - `scope: User or SeatTier or RBACGroup or 3 more`
16862058
16872059 - `User object`
16882060
from line 2099
17272099 - `type: "organization"`
17282100
17292101 default: organization
2102
2103 - `Workspace object`
2104
2105 Scope selecting one workspace of a Claude Console organization.
2106
2107 - `type: "workspace"`
2108
2109 Scope type. Always `workspace` for this scope.
2110
2111 default: workspace
2112
2113 - `workspace_id: string`
2114
2115 Tagged ID of the workspace the spend limit applies to.
2116
2117 - `source: User or SeatTier or RBACGroup or 3 more`
2118
2119 - `User object`
2120
2121 Scope selecting a single member of the organization.
2122
2123 - `type: "user"`
2124
2125 Scope type. Always `user` for this scope.
2126
2127 default: user
2128
2129 - `user_id: string`
2130
2131 Tagged ID of the member the spend limit applies to.
2132
2133 - `SeatTier object`
2134
2135 - `type: "seat_tier"`
2136
2137 default: seat_tier
2138
2139 - `seat_tier: string`
2140
2141 - `RBACGroup object`
2142
2143 - `type: "rbac_group"`
2144
2145 default: rbac_group
2146
2147 - `rbac_group_id: string`
2148
2149 - `OrganizationService object`
2150
2151 - `type: "organization_service"`
2152
2153 default: organization_service
2154
2155 - `service: string`
2156
2157 - `Organization object`
2158
2159 - `type: "organization"`
2160
2161 default: organization
2162
2163 - `Workspace object`
2164
2165 Scope selecting one workspace of a Claude Console organization.
2166
2167 - `type: "workspace"`
2168
2169 Scope type. Always `workspace` for this scope.
2170
2171 default: workspace
2172
2173 - `workspace_id: string`
2174
2175 Tagged ID of the workspace the spend limit applies to.
17302176
17312177 - `spend_limit_id: string`
17322178
from line 2380
19342380
19352381 Per-member effective-limit report row (`GET /spend_limits/effective`).
19362382
1937 - `actor: object`
1938
1939 A user within the organization. `name` and `email_address` are
1940 null when the underlying account is unavailable or has been deleted;
1941 `deleted` is true only for deleted accounts.
1942
1943 - `type: "user_actor"`
1944
1945 Actor type. Always `user_actor`.
1946
1947 default: user_actor
1948
1949 - `deleted: boolean`
1950
1951 True only when the underlying account has been deleted.
1952
1953 default: false
1954
1955 - `email_address: string or null`
1956
1957 The user's email address. Null when the account is unavailable or has been deleted.
1958
1959 - `name: string or null`
1960
1961 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1962
1963 - `user_id: string`
1964
1965 Tagged ID of the user.
2383 - `actor: UserActor or ScopedAPIKeyActor`
2384
2385 - `UserActor object`
2386
2387 A user within the organization. `name` and `email_address` are
2388 null when the underlying account is unavailable or has been deleted;
2389 `deleted` is true only for deleted accounts.
2390
2391 - `type: "user_actor"`
2392
2393 Actor type. Always `user_actor`.
2394
2395 default: user_actor
2396
2397 - `deleted: boolean`
2398
2399 True only when the underlying account has been deleted.
2400
2401 default: false
2402
2403 - `email_address: string or null`
2404
2405 The user's email address. Null when the account is unavailable or has been deleted.
2406
2407 - `name: string or null`
2408
2409 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2410
2411 - `user_id: string`
2412
2413 Tagged ID of the user.
2414
2415 - `ScopedAPIKeyActor object`
2416
2417 A scoped Admin API key acting on behalf of the organization.
2418
2419 - `type: "scoped_api_key_actor"`
2420
2421 default: scoped_api_key_actor
2422
2423 - `scoped_api_key_id: string`
19662424
19672425 - `amount: string or null`
19682426
from line 2444
19862444
19872445 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.
19882446
1989 - `scope: object`
1990
1991 Scope selecting a single member of the organization.
1992
1993 - `type: "user"`
1994
1995 Scope type. Always `user` for this scope.
1996
1997 default: user
1998
1999 - `user_id: string`
2000
2001 Tagged ID of the member the spend limit applies to.
2002
2003 - `source: User or SeatTier or RBACGroup or 2 more`
2447 - `scope: User or SeatTier or RBACGroup or 3 more`
20042448
20052449 - `User object`
20062450
from line 2489
20452489 - `type: "organization"`
20462490
20472491 default: organization
2492
2493 - `Workspace object`
2494
2495 Scope selecting one workspace of a Claude Console organization.
2496
2497 - `type: "workspace"`
2498
2499 Scope type. Always `workspace` for this scope.
2500
2501 default: workspace
2502
2503 - `workspace_id: string`
2504
2505 Tagged ID of the workspace the spend limit applies to.
2506
2507 - `source: User or SeatTier or RBACGroup or 3 more`
2508
2509 - `User object`
2510
2511 Scope selecting a single member of the organization.
2512
2513 - `type: "user"`
2514
2515 Scope type. Always `user` for this scope.
2516
2517 default: user
2518
2519 - `user_id: string`
2520
2521 Tagged ID of the member the spend limit applies to.
2522
2523 - `SeatTier object`
2524
2525 - `type: "seat_tier"`
2526
2527 default: seat_tier
2528
2529 - `seat_tier: string`
2530
2531 - `RBACGroup object`
2532
2533 - `type: "rbac_group"`
2534
2535 default: rbac_group
2536
2537 - `rbac_group_id: string`
2538
2539 - `OrganizationService object`
2540
2541 - `type: "organization_service"`
2542
2543 default: organization_service
2544
2545 - `service: string`
2546
2547 - `Organization object`
2548
2549 - `type: "organization"`
2550
2551 default: organization
2552
2553 - `Workspace object`
2554
2555 Scope selecting one workspace of a Claude Console organization.
2556
2557 - `type: "workspace"`
2558
2559 Scope type. Always `workspace` for this scope.
2560
2561 default: workspace
2562
2563 - `workspace_id: string`
2564
2565 Tagged ID of the workspace the spend limit applies to.
20482566
20492567 - `spend_limit_id: string`
20502568
20512569
api/beta/organization/spend_limits/create Changed · +59 / -17 lines
from line 7
77
88**POST** `/v1/organizations/spend_limits`
99
10Set a per-user spend limit override.
10Set a spend limit.
1111
1212Upsert keyed on (scope, period): setting a limit that already exists
13overwrites it in place. Only `scope.type: "user"` is accepted; seat-tier,
14group, and organization-level defaults are configured in claude.ai.
13overwrites it in place. A Claude Enterprise organization sets `user`
14limits. Its seat-tier, group, and organization-level defaults are configured
15in claude.ai. A Claude Console organization sets `organization` and
16`workspace` limits, which are monthly and always carry an amount. Setting those
17limits is in an early access preview. To request access, contact your
18Anthropic account team.
1519
1620## Body parameters
1721
from line 23
1923
2024 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.
2125
22- `scope: object`
26- `scope: User or Organization or Workspace`
2327
24 Scope selecting a single member of the organization.
28 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.
2529
26 - `type: "user"`
30 - `User object`
2731
28 Scope type. Always `user` for this scope.
32 Scope selecting a single member of the organization.
2933
30 default: user
34 - `type: "user"`
3135
32 - `user_id: string`
36 Scope type. Always `user` for this scope.
3337
34 Tagged ID of the member the spend limit applies to.
38 default: user
3539
40 - `user_id: string`
41
42 Tagged ID of the member the spend limit applies to.
43
44 - `Organization object`
45
46 - `type: "organization"`
47
48 default: organization
49
50 - `Workspace object`
51
52 Scope selecting one workspace of a Claude Console organization.
53
54 - `type: "workspace"`
55
56 Scope type. Always `workspace` for this scope.
57
58 default: workspace
59
60 - `workspace_id: string`
61
62 Tagged ID of the workspace the spend limit applies to.
63
3664- `period: optional "daily" or "monthly" or "weekly"`
3765
3866 - `"daily"`
from line 109
81109
82110 - `"weekly"`
83111
84 - `scope: User or SeatTier or RBACGroup or 2 more`
112 - `scope: User or SeatTier or RBACGroup or 3 more`
85113
86114 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
87115
from line 156
128156 - `type: "organization"`
129157
130158 default: organization
159
160 - `Workspace object`
161
162 Scope selecting one workspace of a Claude Console organization.
163
164 - `type: "workspace"`
165
166 Scope type. Always `workspace` for this scope.
167
168 default: workspace
169
170 - `workspace_id: string`
171
172 Tagged ID of the workspace the spend limit applies to.
131173
132174 - `updated_at: string`
133175
api/beta/organization/spend_limits/delete Changed · +6 / -4 lines
from line 7
77
88**DELETE** `/v1/organizations/spend_limits/{spend_limit_id}`
99
10Delete a per-user spend limit override.
10Delete a spend limit.
1111
12The member falls back to any inherited spend limit at that period.
13Seat-tier, group, and organization-level rows cannot be deleted via
14this endpoint.
12For a Claude Enterprise organization, this deletes a per-user override, and
13the member falls back to any inherited spend limit at that period. Its
14seat-tier, group, and organization-level rows cannot be deleted via this
15endpoint. A Claude Console organization deletes its organization and
16workspace limits. Deleting them through the API is in an early access preview.
1517
1618## Path parameters
1719
api/beta/organization/spend_limits/increase_requests Changed · +969 / -509 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 140
140140
141141 Per-member effective-limit report row (`GET /spend_limits/effective`).
142142
143 - `actor: object`
144
145 A user within the organization. `name` and `email_address` are
146 null when the underlying account is unavailable or has been deleted;
147 `deleted` is true only for deleted accounts.
148
149 - `type: "user_actor"`
150
151 Actor type. Always `user_actor`.
152
153 default: user_actor
154
155 - `deleted: boolean`
156
157 True only when the underlying account has been deleted.
158
159 default: false
160
161 - `email_address: string or null`
162
163 The user's email address. Null when the account is unavailable or has been deleted.
164
165 - `name: string or null`
166
167 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
168
169 - `user_id: string`
170
171 Tagged ID of the user.
143 - `actor: UserActor or ScopedAPIKeyActor`
144
145 - `UserActor object`
146
147 A user within the organization. `name` and `email_address` are
148 null when the underlying account is unavailable or has been deleted;
149 `deleted` is true only for deleted accounts.
150
151 - `type: "user_actor"`
152
153 Actor type. Always `user_actor`.
154
155 default: user_actor
156
157 - `deleted: boolean`
158
159 True only when the underlying account has been deleted.
160
161 default: false
162
163 - `email_address: string or null`
164
165 The user's email address. Null when the account is unavailable or has been deleted.
166
167 - `name: string or null`
168
169 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
170
171 - `user_id: string`
172
173 Tagged ID of the user.
174
175 - `ScopedAPIKeyActor object`
176
177 A scoped Admin API key acting on behalf of the organization.
178
179 - `type: "scoped_api_key_actor"`
180
181 default: scoped_api_key_actor
182
183 - `scoped_api_key_id: string`
172184
173185 - `amount: string or null`
174186
from line 204
192204
193205 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.
194206
195 - `scope: object`
196
197 Scope selecting a single member of the organization.
198
199 - `type: "user"`
200
201 Scope type. Always `user` for this scope.
202
203 default: user
204
205 - `user_id: string`
206
207 Tagged ID of the member the spend limit applies to.
208
209 - `source: User or SeatTier or RBACGroup or 2 more`
207 - `scope: User or SeatTier or RBACGroup or 3 more`
210208
211209 - `User object`
212210
from line 249
251249 - `type: "organization"`
252250
253251 default: organization
252
253 - `Workspace object`
254
255 Scope selecting one workspace of a Claude Console organization.
256
257 - `type: "workspace"`
258
259 Scope type. Always `workspace` for this scope.
260
261 default: workspace
262
263 - `workspace_id: string`
264
265 Tagged ID of the workspace the spend limit applies to.
266
267 - `source: User or SeatTier or RBACGroup or 3 more`
268
269 - `User object`
270
271 Scope selecting a single member of the organization.
272
273 - `type: "user"`
274
275 Scope type. Always `user` for this scope.
276
277 default: user
278
279 - `user_id: string`
280
281 Tagged ID of the member the spend limit applies to.
282
283 - `SeatTier object`
284
285 - `type: "seat_tier"`
286
287 default: seat_tier
288
289 - `seat_tier: string`
290
291 - `RBACGroup object`
292
293 - `type: "rbac_group"`
294
295 default: rbac_group
296
297 - `rbac_group_id: string`
298
299 - `OrganizationService object`
300
301 - `type: "organization_service"`
302
303 default: organization_service
304
305 - `service: string`
306
307 - `Organization object`
308
309 - `type: "organization"`
310
311 default: organization
312
313 - `Workspace object`
314
315 Scope selecting one workspace of a Claude Console organization.
316
317 - `type: "workspace"`
318
319 Scope type. Always `workspace` for this scope.
320
321 default: workspace
322
323 - `workspace_id: string`
324
325 Tagged ID of the workspace the spend limit applies to.
254326
255327 - `spend_limit_id: string`
256328
from line 515
443515
444516 Per-member effective-limit report row (`GET /spend_limits/effective`).
445517
446 - `actor: object`
447
448 A user within the organization. `name` and `email_address` are
449 null when the underlying account is unavailable or has been deleted;
450 `deleted` is true only for deleted accounts.
451
452 - `type: "user_actor"`
453
454 Actor type. Always `user_actor`.
455
456 default: user_actor
457
458 - `deleted: boolean`
459
460 True only when the underlying account has been deleted.
461
462 default: false
463
464 - `email_address: string or null`
465
466 The user's email address. Null when the account is unavailable or has been deleted.
467
468 - `name: string or null`
469
470 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
471
472 - `user_id: string`
473
474 Tagged ID of the user.
518 - `actor: UserActor or ScopedAPIKeyActor`
519
520 - `UserActor object`
521
522 A user within the organization. `name` and `email_address` are
523 null when the underlying account is unavailable or has been deleted;
524 `deleted` is true only for deleted accounts.
525
526 - `type: "user_actor"`
527
528 Actor type. Always `user_actor`.
529
530 default: user_actor
531
532 - `deleted: boolean`
533
534 True only when the underlying account has been deleted.
535
536 default: false
537
538 - `email_address: string or null`
539
540 The user's email address. Null when the account is unavailable or has been deleted.
541
542 - `name: string or null`
543
544 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
545
546 - `user_id: string`
547
548 Tagged ID of the user.
549
550 - `ScopedAPIKeyActor object`
551
552 A scoped Admin API key acting on behalf of the organization.
553
554 - `type: "scoped_api_key_actor"`
555
556 default: scoped_api_key_actor
557
558 - `scoped_api_key_id: string`
475559
476560 - `amount: string or null`
477561
from line 579
495579
496580 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.
497581
498 - `scope: object`
499
500 Scope selecting a single member of the organization.
501
502 - `type: "user"`
503
504 Scope type. Always `user` for this scope.
505
506 default: user
507
508 - `user_id: string`
509
510 Tagged ID of the member the spend limit applies to.
511
512 - `source: User or SeatTier or RBACGroup or 2 more`
582 - `scope: User or SeatTier or RBACGroup or 3 more`
513583
514584 - `User object`
515585
from line 624
554624 - `type: "organization"`
555625
556626 default: organization
627
628 - `Workspace object`
629
630 Scope selecting one workspace of a Claude Console organization.
631
632 - `type: "workspace"`
633
634 Scope type. Always `workspace` for this scope.
635
636 default: workspace
637
638 - `workspace_id: string`
639
640 Tagged ID of the workspace the spend limit applies to.
641
642 - `source: User or SeatTier or RBACGroup or 3 more`
643
644 - `User object`
645
646 Scope selecting a single member of the organization.
647
648 - `type: "user"`
649
650 Scope type. Always `user` for this scope.
651
652 default: user
653
654 - `user_id: string`
655
656 Tagged ID of the member the spend limit applies to.
657
658 - `SeatTier object`
659
660 - `type: "seat_tier"`
661
662 default: seat_tier
663
664 - `seat_tier: string`
665
666 - `RBACGroup object`
667
668 - `type: "rbac_group"`
669
670 default: rbac_group
671
672 - `rbac_group_id: string`
673
674 - `OrganizationService object`
675
676 - `type: "organization_service"`
677
678 default: organization_service
679
680 - `service: string`
681
682 - `Organization object`
683
684 - `type: "organization"`
685
686 default: organization
687
688 - `Workspace object`
689
690 Scope selecting one workspace of a Claude Console organization.
691
692 - `type: "workspace"`
693
694 Scope type. Always `workspace` for this scope.
695
696 default: workspace
697
698 - `workspace_id: string`
699
700 Tagged ID of the workspace the spend limit applies to.
557701
558702 - `spend_limit_id: string`
559703
from line 933
789933
790934 - `"weekly"`
791935
792 - `scope: User or SeatTier or RBACGroup or 2 more`
936 - `scope: User or SeatTier or RBACGroup or 3 more`
793937
794938 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
795939
from line 981
837981
838982 default: organization
839983
984 - `Workspace object`
985
986 Scope selecting one workspace of a Claude Console organization.
987
988 - `type: "workspace"`
989
990 Scope type. Always `workspace` for this scope.
991
992 default: workspace
993
994 - `workspace_id: string`
995
996 Tagged ID of the workspace the spend limit applies to.
997
840998 - `updated_at: string`
841999
8421000 RFC 3339 datetime at which the spend limit was last modified.
from line 1005
8471005
8481006 Per-member effective-limit report row (`GET /spend_limits/effective`).
8491007
850 - `actor: object`
851
852 A user within the organization. `name` and `email_address` are
853 null when the underlying account is unavailable or has been deleted;
854 `deleted` is true only for deleted accounts.
855
856 - `type: "user_actor"`
857
858 Actor type. Always `user_actor`.
859
860 default: user_actor
861
862 - `deleted: boolean`
863
864 True only when the underlying account has been deleted.
865
866 default: false
867
868 - `email_address: string or null`
869
870 The user's email address. Null when the account is unavailable or has been deleted.
871
872 - `name: string or null`
873
874 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
875
876 - `user_id: string`
877
878 Tagged ID of the user.
1008 - `actor: UserActor or ScopedAPIKeyActor`
1009
1010 - `UserActor object`
1011
1012 A user within the organization. `name` and `email_address` are
1013 null when the underlying account is unavailable or has been deleted;
1014 `deleted` is true only for deleted accounts.
1015
1016 - `type: "user_actor"`
1017
1018 Actor type. Always `user_actor`.
1019
1020 default: user_actor
1021
1022 - `deleted: boolean`
1023
1024 True only when the underlying account has been deleted.
1025
1026 default: false
1027
1028 - `email_address: string or null`
1029
1030 The user's email address. Null when the account is unavailable or has been deleted.
1031
1032 - `name: string or null`
1033
1034 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1035
1036 - `user_id: string`
1037
1038 Tagged ID of the user.
1039
1040 - `ScopedAPIKeyActor object`
1041
1042 A scoped Admin API key acting on behalf of the organization.
1043
1044 - `type: "scoped_api_key_actor"`
1045
1046 default: scoped_api_key_actor
1047
1048 - `scoped_api_key_id: string`
8791049
8801050 - `amount: string or null`
8811051
from line 1069
8991069
9001070 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.
9011071
902 - `scope: object`
903
904 Scope selecting a single member of the organization.
905
906 - `type: "user"`
907
908 Scope type. Always `user` for this scope.
909
910 default: user
911
912 - `user_id: string`
913
914 Tagged ID of the member the spend limit applies to.
915
916 - `source: User or SeatTier or RBACGroup or 2 more`
1072 - `scope: User or SeatTier or RBACGroup or 3 more`
9171073
9181074 - `User object`
9191075
from line 1114
9581114 - `type: "organization"`
9591115
9601116 default: organization
1117
1118 - `Workspace object`
1119
1120 Scope selecting one workspace of a Claude Console organization.
1121
1122 - `type: "workspace"`
1123
1124 Scope type. Always `workspace` for this scope.
1125
1126 default: workspace
1127
1128 - `workspace_id: string`
1129
1130 Tagged ID of the workspace the spend limit applies to.
1131
1132 - `source: User or SeatTier or RBACGroup or 3 more`
1133
1134 - `User object`
1135
1136 Scope selecting a single member of the organization.
1137
1138 - `type: "user"`
1139
1140 Scope type. Always `user` for this scope.
1141
1142 default: user
1143
1144 - `user_id: string`
1145
1146 Tagged ID of the member the spend limit applies to.
1147
1148 - `SeatTier object`
1149
1150 - `type: "seat_tier"`
1151
1152 default: seat_tier
1153
1154 - `seat_tier: string`
1155
1156 - `RBACGroup object`
1157
1158 - `type: "rbac_group"`
1159
1160 default: rbac_group
1161
1162 - `rbac_group_id: string`
1163
1164 - `OrganizationService object`
1165
1166 - `type: "organization_service"`
1167
1168 default: organization_service
1169
1170 - `service: string`
1171
1172 - `Organization object`
1173
1174 - `type: "organization"`
1175
1176 default: organization
1177
1178 - `Workspace object`
1179
1180 Scope selecting one workspace of a Claude Console organization.
1181
1182 - `type: "workspace"`
1183
1184 Scope type. Always `workspace` for this scope.
1185
1186 default: workspace
1187
1188 - `workspace_id: string`
1189
1190 Tagged ID of the workspace the spend limit applies to.
9611191
9621192 - `spend_limit_id: string`
9631193
from line 1395
11651395
11661396 Per-member effective-limit report row (`GET /spend_limits/effective`).
11671397
1168 - `actor: object`
1169
1170 A user within the organization. `name` and `email_address` are
1171 null when the underlying account is unavailable or has been deleted;
1172 `deleted` is true only for deleted accounts.
1173
1174 - `type: "user_actor"`
1175
1176 Actor type. Always `user_actor`.
1177
1178 default: user_actor
1179
1180 - `deleted: boolean`
1181
1182 True only when the underlying account has been deleted.
1183
1184 default: false
1185
1186 - `email_address: string or null`
1187
1188 The user's email address. Null when the account is unavailable or has been deleted.
1189
1190 - `name: string or null`
1191
1192 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1193
1194 - `user_id: string`
1195
1196 Tagged ID of the user.
1398 - `actor: UserActor or ScopedAPIKeyActor`
1399
1400 - `UserActor object`
1401
1402 A user within the organization. `name` and `email_address` are
1403 null when the underlying account is unavailable or has been deleted;
1404 `deleted` is true only for deleted accounts.
1405
1406 - `type: "user_actor"`
1407
1408 Actor type. Always `user_actor`.
1409
1410 default: user_actor
1411
1412 - `deleted: boolean`
1413
1414 True only when the underlying account has been deleted.
1415
1416 default: false
1417
1418 - `email_address: string or null`
1419
1420 The user's email address. Null when the account is unavailable or has been deleted.
1421
1422 - `name: string or null`
1423
1424 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1425
1426 - `user_id: string`
1427
1428 Tagged ID of the user.
1429
1430 - `ScopedAPIKeyActor object`
1431
1432 A scoped Admin API key acting on behalf of the organization.
1433
1434 - `type: "scoped_api_key_actor"`
1435
1436 default: scoped_api_key_actor
1437
1438 - `scoped_api_key_id: string`
11971439
11981440 - `amount: string or null`
11991441
from line 1459
12171459
12181460 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.
12191461
1220 - `scope: object`
1221
1222 Scope selecting a single member of the organization.
1223
1224 - `type: "user"`
1225
1226 Scope type. Always `user` for this scope.
1227
1228 default: user
1229
1230 - `user_id: string`
1231
1232 Tagged ID of the member the spend limit applies to.
1233
1234 - `source: User or SeatTier or RBACGroup or 2 more`
1462 - `scope: User or SeatTier or RBACGroup or 3 more`
12351463
12361464 - `User object`
12371465
from line 1504
12761504 - `type: "organization"`
12771505
12781506 default: organization
1507
1508 - `Workspace object`
1509
1510 Scope selecting one workspace of a Claude Console organization.
1511
1512 - `type: "workspace"`
1513
1514 Scope type. Always `workspace` for this scope.
1515
1516 default: workspace
1517
1518 - `workspace_id: string`
1519
1520 Tagged ID of the workspace the spend limit applies to.
1521
1522 - `source: User or SeatTier or RBACGroup or 3 more`
1523
1524 - `User object`
1525
1526 Scope selecting a single member of the organization.
1527
1528 - `type: "user"`
1529
1530 Scope type. Always `user` for this scope.
1531
1532 default: user
1533
1534 - `user_id: string`
1535
1536 Tagged ID of the member the spend limit applies to.
1537
1538 - `SeatTier object`
1539
1540 - `type: "seat_tier"`
1541
1542 default: seat_tier
1543
1544 - `seat_tier: string`
1545
1546 - `RBACGroup object`
1547
1548 - `type: "rbac_group"`
1549
1550 default: rbac_group
1551
1552 - `rbac_group_id: string`
1553
1554 - `OrganizationService object`
1555
1556 - `type: "organization_service"`
1557
1558 default: organization_service
1559
1560 - `service: string`
1561
1562 - `Organization object`
1563
1564 - `type: "organization"`
1565
1566 default: organization
1567
1568 - `Workspace object`
1569
1570 Scope selecting one workspace of a Claude Console organization.
1571
1572 - `type: "workspace"`
1573
1574 Scope type. Always `workspace` for this scope.
1575
1576 default: workspace
1577
1578 - `workspace_id: string`
1579
1580 Tagged ID of the workspace the spend limit applies to.
12791581
12801582 - `spend_limit_id: string`
12811583
from line 1752
14501752
14511753 Per-member effective-limit report row (`GET /spend_limits/effective`).
14521754
1453 - `actor: object`
1755 - `actor: UserActor or ScopedAPIKeyActor`
1756
1757 - `UserActor object`
1758
1759 A user within the organization. `name` and `email_address` are
1760 null when the underlying account is unavailable or has been deleted;
1761 `deleted` is true only for deleted accounts.
1762
1763 - `type: "user_actor"`
1764
1765 Actor type. Always `user_actor`.
1766
1767 default: user_actor
1768
1769 - `deleted: boolean`
1770
1771 True only when the underlying account has been deleted.
1772
1773 default: false
1774
1775 - `email_address: string or null`
1776
1777 The user's email address. Null when the account is unavailable or has been deleted.
1778
1779 - `name: string or null`
1780
1781 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1782
1783 - `user_id: string`
1784
1785 Tagged ID of the user.
1786
1787 - `ScopedAPIKeyActor object`
1788
1789 A scoped Admin API key acting on behalf of the organization.
1790
1791 - `type: "scoped_api_key_actor"`
1792
1793 default: scoped_api_key_actor
1794
1795 - `scoped_api_key_id: string`
1796
1797 - `amount: string or null`
1798
1799 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.
1800
1801 - `currency: string`
1802
1803 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1804
1805 - `period: "daily" or "monthly" or "weekly"`
1806
1807 Period this row's effective limit and spend are reported for.
1808
1809 - `"daily"`
1810
1811 - `"monthly"`
1812
1813 - `"weekly"`
1814
1815 - `period_to_date_spend: string`
1816
1817 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.
1818
1819 - `scope: User or SeatTier or RBACGroup or 3 more`
1820
1821 - `User object`
1822
1823 Scope selecting a single member of the organization.
1824
1825 - `type: "user"`
1826
1827 Scope type. Always `user` for this scope.
1828
1829 default: user
1830
1831 - `user_id: string`
1832
1833 Tagged ID of the member the spend limit applies to.
1834
1835 - `SeatTier object`
1836
1837 - `type: "seat_tier"`
1838
1839 default: seat_tier
1840
1841 - `seat_tier: string`
1842
1843 - `RBACGroup object`
1844
1845 - `type: "rbac_group"`
1846
1847 default: rbac_group
1848
1849 - `rbac_group_id: string`
1850
1851 - `OrganizationService object`
1852
1853 - `type: "organization_service"`
1854
1855 default: organization_service
1856
1857 - `service: string`
1858
1859 - `Organization object`
1860
1861 - `type: "organization"`
1862
1863 default: organization
1864
1865 - `Workspace object`
1866
1867 Scope selecting one workspace of a Claude Console organization.
1868
1869 - `type: "workspace"`
1870
1871 Scope type. Always `workspace` for this scope.
1872
1873 default: workspace
1874
1875 - `workspace_id: string`
1876
1877 Tagged ID of the workspace the spend limit applies to.
1878
1879 - `source: User or SeatTier or RBACGroup or 3 more`
1880
1881 - `User object`
1882
1883 Scope selecting a single member of the organization.
1884
1885 - `type: "user"`
1886
1887 Scope type. Always `user` for this scope.
1888
1889 default: user
1890
1891 - `user_id: string`
1892
1893 Tagged ID of the member the spend limit applies to.
1894
1895 - `SeatTier object`
1896
1897 - `type: "seat_tier"`
1898
1899 default: seat_tier
1900
1901 - `seat_tier: string`
1902
1903 - `RBACGroup object`
1904
1905 - `type: "rbac_group"`
1906
1907 default: rbac_group
1908
1909 - `rbac_group_id: string`
1910
1911 - `OrganizationService object`
1912
1913 - `type: "organization_service"`
1914
1915 default: organization_service
1916
1917 - `service: string`
1918
1919 - `Organization object`
1920
1921 - `type: "organization"`
1922
1923 default: organization
1924
1925 - `Workspace object`
1926
1927 Scope selecting one workspace of a Claude Console organization.
1928
1929 - `type: "workspace"`
1930
1931 Scope type. Always `workspace` for this scope.
1932
1933 default: workspace
1934
1935 - `workspace_id: string`
1936
1937 Tagged ID of the workspace the spend limit applies to.
1938
1939 - `spend_limit_id: string`
1940
1941 - `status: "approved" or "denied" or "pending"`
1942
1943 - `"approved"`
1944
1945 - `"denied"`
1946
1947 - `"pending"`
1948
1949### Increase Request Approve Response
1950
1951- `IncreaseRequestApproveResponse object`
1952
1953 - `type: "spend_limit_increase_request"`
1954
1955 default: spend_limit_increase_request
1956
1957 - `id: string`
1958
1959 - `actor: object`
1960
1961 A user within the organization. `name` and `email_address` are
1962 null when the underlying account is unavailable or has been deleted;
1963 `deleted` is true only for deleted accounts.
1964
1965 - `type: "user_actor"`
1966
1967 Actor type. Always `user_actor`.
1968
1969 default: user_actor
1970
1971 - `deleted: boolean`
1972
1973 True only when the underlying account has been deleted.
1974
1975 default: false
1976
1977 - `email_address: string or null`
1978
1979 The user's email address. Null when the account is unavailable or has been deleted.
1980
1981 - `name: string or null`
1982
1983 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1984
1985 - `user_id: string`
1986
1987 Tagged ID of the user.
1988
1989 - `created_at: string`
1990
1991 format: date-time
1992
1993 - `period: "daily" or "monthly" or "weekly"`
1994
1995 - `"daily"`
1996
1997 - `"monthly"`
1998
1999 - `"weekly"`
2000
2001 - `resolved_at: string or null`
2002
2003 format: date-time
2004
2005 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
2006
2007 - `UserActor object`
14542008
14552009 A user within the organization. `name` and `email_address` are
14562010 null when the underlying account is unavailable or has been deleted;
from line 2034
14802034
14812035 Tagged ID of the user.
14822036
2037 - `ScopedAPIKeyActor object`
2038
2039 A scoped Admin API key acting on behalf of the organization.
2040
2041 - `type: "scoped_api_key_actor"`
2042
2043 default: scoped_api_key_actor
2044
2045 - `scoped_api_key_id: string`
2046
2047 - `spend_limit: BetaSpendLimit`
2048
2049 A configured spend limit: a cap on metered spend for one scope and period.
2050
2051 - `type: "spend_limit"`
2052
2053 Object type. Always `spend_limit`.
2054
2055 default: spend_limit
2056
2057 - `id: string`
2058
2059 Unique tagged ID of the spend limit (`spl_...`).
2060
14832061 - `amount: string or null`
14842062
2063 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.
2064
2065 - `created_at: string`
2066
2067 RFC 3339 datetime at which the spend limit was created.
2068
2069 format: date-time
2070
2071 - `currency: string`
2072
2073 ISO 4217 code of the organization's billing currency; the unit for `amount`.
2074
2075 - `period: "daily" or "monthly" or "weekly"`
2076
2077 Length of the window the limit resets over. `amount` caps spend within each period.
2078
2079 - `"daily"`
2080
2081 - `"monthly"`
2082
2083 - `"weekly"`
2084
2085 - `scope: User or SeatTier or RBACGroup or 3 more`
2086
2087 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
2088
2089 - `User object`
2090
2091 Scope selecting a single member of the organization.
2092
2093 - `type: "user"`
2094
2095 Scope type. Always `user` for this scope.
2096
2097 default: user
2098
2099 - `user_id: string`
2100
2101 Tagged ID of the member the spend limit applies to.
2102
2103 - `SeatTier object`
2104
2105 - `type: "seat_tier"`
2106
2107 default: seat_tier
2108
2109 - `seat_tier: string`
2110
2111 - `RBACGroup object`
2112
2113 - `type: "rbac_group"`
2114
2115 default: rbac_group
2116
2117 - `rbac_group_id: string`
2118
2119 - `OrganizationService object`
2120
2121 - `type: "organization_service"`
2122
2123 default: organization_service
2124
2125 - `service: string`
2126
2127 - `Organization object`
2128
2129 - `type: "organization"`
2130
2131 default: organization
2132
2133 - `Workspace object`
2134
2135 Scope selecting one workspace of a Claude Console organization.
2136
2137 - `type: "workspace"`
2138
2139 Scope type. Always `workspace` for this scope.
2140
2141 default: workspace
2142
2143 - `workspace_id: string`
2144
2145 Tagged ID of the workspace the spend limit applies to.
2146
2147 - `updated_at: string`
2148
2149 RFC 3339 datetime at which the spend limit was last modified.
2150
2151 format: date-time
2152
2153 - `spend_summary: BetaSpendSummary or null`
2154
2155 Per-member effective-limit report row (`GET /spend_limits/effective`).
2156
2157 - `actor: UserActor or ScopedAPIKeyActor`
2158
2159 - `UserActor object`
2160
2161 A user within the organization. `name` and `email_address` are
2162 null when the underlying account is unavailable or has been deleted;
2163 `deleted` is true only for deleted accounts.
2164
2165 - `type: "user_actor"`
2166
2167 Actor type. Always `user_actor`.
2168
2169 default: user_actor
2170
2171 - `deleted: boolean`
2172
2173 True only when the underlying account has been deleted.
2174
2175 default: false
2176
2177 - `email_address: string or null`
2178
2179 The user's email address. Null when the account is unavailable or has been deleted.
2180
2181 - `name: string or null`
2182
2183 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
2184
2185 - `user_id: string`
2186
2187 Tagged ID of the user.
2188
2189 - `ScopedAPIKeyActor object`
2190
2191 A scoped Admin API key acting on behalf of the organization.
2192
2193 - `type: "scoped_api_key_actor"`
2194
2195 default: scoped_api_key_actor
2196
2197 - `scoped_api_key_id: string`
2198
2199 - `amount: string or null`
2200
14852201 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.
14862202
14872203 - `currency: string`
from line 2218
15022218
15032219 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.
15042220
1505 - `scope: object`
1506
1507 Scope selecting a single member of the organization.
1508
1509 - `type: "user"`
1510
1511 Scope type. Always `user` for this scope.
1512
1513 default: user
1514
1515 - `user_id: string`
1516
1517 Tagged ID of the member the spend limit applies to.
1518
1519 - `source: User or SeatTier or RBACGroup or 2 more`
2221 - `scope: User or SeatTier or RBACGroup or 3 more`
15202222
15212223 - `User object`
15222224
from line 2264
15622264
15632265 default: organization
15642266
2267 - `Workspace object`
2268
2269 Scope selecting one workspace of a Claude Console organization.
2270
2271 - `type: "workspace"`
2272
2273 Scope type. Always `workspace` for this scope.
2274
2275 default: workspace
2276
2277 - `workspace_id: string`
2278
2279 Tagged ID of the workspace the spend limit applies to.
2280
2281 - `source: User or SeatTier or RBACGroup or 3 more`
2282
2283 - `User object`
2284
2285 Scope selecting a single member of the organization.
2286
2287 - `type: "user"`
2288
2289 Scope type. Always `user` for this scope.
2290
2291 default: user
2292
2293 - `user_id: string`
2294
2295 Tagged ID of the member the spend limit applies to.
2296
2297 - `SeatTier object`
2298
2299 - `type: "seat_tier"`
2300
2301 default: seat_tier
2302
2303 - `seat_tier: string`
2304
2305 - `RBACGroup object`
2306
2307 - `type: "rbac_group"`
2308
2309 default: rbac_group
2310
2311 - `rbac_group_id: string`
2312
2313 - `OrganizationService object`
2314
2315 - `type: "organization_service"`
2316
2317 default: organization_service
2318
2319 - `service: string`
2320
2321 - `Organization object`
2322
2323 - `type: "organization"`
2324
2325 default: organization
2326
2327 - `Workspace object`
2328
2329 Scope selecting one workspace of a Claude Console organization.
2330
2331 - `type: "workspace"`
2332
2333 Scope type. Always `workspace` for this scope.
2334
2335 default: workspace
2336
2337 - `workspace_id: string`
2338
2339 Tagged ID of the workspace the spend limit applies to.
2340
15652341 - `spend_limit_id: string`
15662342
15672343 - `status: "approved" or "denied" or "pending"`
from line 2347
15712347 - `"denied"`
15722348
15732349 - `"pending"`
1574
1575### Increase Request Approve Response
1576
1577- `IncreaseRequestApproveResponse object`
1578
1579 - `type: "spend_limit_increase_request"`
1580
1581 default: spend_limit_increase_request
1582
1583 - `id: string`
1584
1585 - `actor: object`
1586
1587 A user within the organization. `name` and `email_address` are
1588 null when the underlying account is unavailable or has been deleted;
1589 `deleted` is true only for deleted accounts.
1590
1591 - `type: "user_actor"`
1592
1593 Actor type. Always `user_actor`.
1594
1595 default: user_actor
1596
1597 - `deleted: boolean`
1598
1599 True only when the underlying account has been deleted.
1600
1601 default: false
1602
1603 - `email_address: string or null`
1604
1605 The user's email address. Null when the account is unavailable or has been deleted.
1606
1607 - `name: string or null`
1608
1609 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1610
1611 - `user_id: string`
1612
1613 Tagged ID of the user.
1614
1615 - `created_at: string`
1616
1617 format: date-time
1618
1619 - `period: "daily" or "monthly" or "weekly"`
1620
1621 - `"daily"`
1622
1623 - `"monthly"`
1624
1625 - `"weekly"`
1626
1627 - `resolved_at: string or null`
1628
1629 format: date-time
1630
1631 - `resolved_by: UserActor or ScopedAPIKeyActor or null`
1632
1633 - `UserActor object`
1634
1635 A user within the organization. `name` and `email_address` are
1636 null when the underlying account is unavailable or has been deleted;
1637 `deleted` is true only for deleted accounts.
1638
1639 - `type: "user_actor"`
1640
1641 Actor type. Always `user_actor`.
1642
1643 default: user_actor
1644
1645 - `deleted: boolean`
1646
1647 True only when the underlying account has been deleted.
1648
1649 default: false
1650
1651 - `email_address: string or null`
1652
1653 The user's email address. Null when the account is unavailable or has been deleted.
1654
1655 - `name: string or null`
1656
1657 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1658
1659 - `user_id: string`
1660
1661 Tagged ID of the user.
1662
1663 - `ScopedAPIKeyActor object`
1664
1665 A scoped Admin API key acting on behalf of the organization.
1666
1667 - `type: "scoped_api_key_actor"`
1668
1669 default: scoped_api_key_actor
1670
1671 - `scoped_api_key_id: string`
1672
1673 - `spend_limit: BetaSpendLimit`
1674
1675 A configured spend limit: a cap on metered spend for one scope and period.
1676
1677 - `type: "spend_limit"`
1678
1679 Object type. Always `spend_limit`.
1680
1681 default: spend_limit
1682
1683 - `id: string`
1684
1685 Unique tagged ID of the spend limit (`spl_...`).
1686
1687 - `amount: string or null`
1688
1689 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.
1690
1691 - `created_at: string`
1692
1693 RFC 3339 datetime at which the spend limit was created.
1694
1695 format: date-time
1696
1697 - `currency: string`
1698
1699 ISO 4217 code of the organization's billing currency; the unit for `amount`.
1700
1701 - `period: "daily" or "monthly" or "weekly"`
1702
1703 Length of the window the limit resets over. `amount` caps spend within each period.
1704
1705 - `"daily"`
1706
1707 - `"monthly"`
1708
1709 - `"weekly"`
1710
1711 - `scope: User or SeatTier or RBACGroup or 2 more`
1712
1713 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
1714
1715 - `User object`
1716
1717 Scope selecting a single member of the organization.
1718
1719 - `type: "user"`
1720
1721 Scope type. Always `user` for this scope.
1722
1723 default: user
1724
1725 - `user_id: string`
1726
1727 Tagged ID of the member the spend limit applies to.
1728
1729 - `SeatTier object`
1730
1731 - `type: "seat_tier"`
1732
1733 default: seat_tier
1734
1735 - `seat_tier: string`
1736
1737 - `RBACGroup object`
1738
1739 - `type: "rbac_group"`
1740
1741 default: rbac_group
1742
1743 - `rbac_group_id: string`
1744
1745 - `OrganizationService object`
1746
1747 - `type: "organization_service"`
1748
1749 default: organization_service
1750
1751 - `service: string`
1752
1753 - `Organization object`
1754
1755 - `type: "organization"`
1756
1757 default: organization
1758
1759 - `updated_at: string`
1760
1761 RFC 3339 datetime at which the spend limit was last modified.
1762
1763 format: date-time
1764
1765 - `spend_summary: BetaSpendSummary or null`
1766
1767 Per-member effective-limit report row (`GET /spend_limits/effective`).
1768
1769 - `actor: object`
1770
1771 A user within the organization. `name` and `email_address` are
1772 null when the underlying account is unavailable or has been deleted;
1773 `deleted` is true only for deleted accounts.
1774
1775 - `type: "user_actor"`
1776
1777 Actor type. Always `user_actor`.
1778
1779 default: user_actor
1780
1781 - `deleted: boolean`
1782
1783 True only when the underlying account has been deleted.
1784
1785 default: false
1786
1787 - `email_address: string or null`
1788
1789 The user's email address. Null when the account is unavailable or has been deleted.
1790
1791 - `name: string or null`
1792
1793 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
1794
1795 - `user_id: string`
1796
1797 Tagged ID of the user.
1798
1799 - `amount: string or null`
1800
1801 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.
1802
1803 - `currency: string`
1804
1805 ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`.
1806
1807 - `period: "daily" or "monthly" or "weekly"`
1808
1809 Period this row's effective limit and spend are reported for.
1810
1811 - `"daily"`
1812
1813 - `"monthly"`
1814
1815 - `"weekly"`
1816
1817 - `period_to_date_spend: string`
1818
1819 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.
1820
1821 - `scope: object`
1822
1823 Scope selecting a single member of the organization.
1824
1825 - `type: "user"`
1826
1827 Scope type. Always `user` for this scope.
1828
1829 default: user
1830
1831 - `user_id: string`
1832
1833 Tagged ID of the member the spend limit applies to.
1834
1835 - `source: User or SeatTier or RBACGroup or 2 more`
1836
1837 - `User object`
1838
1839 Scope selecting a single member of the organization.
1840
1841 - `type: "user"`
1842
1843 Scope type. Always `user` for this scope.
1844
1845 default: user
1846
1847 - `user_id: string`
1848
1849 Tagged ID of the member the spend limit applies to.
1850
1851 - `SeatTier object`
1852
1853 - `type: "seat_tier"`
1854
1855 default: seat_tier
1856
1857 - `seat_tier: string`
1858
1859 - `RBACGroup object`
1860
1861 - `type: "rbac_group"`
1862
1863 default: rbac_group
1864
1865 - `rbac_group_id: string`
1866
1867 - `OrganizationService object`
1868
1869 - `type: "organization_service"`
1870
1871 default: organization_service
1872
1873 - `service: string`
1874
1875 - `Organization object`
1876
1877 - `type: "organization"`
1878
1879 default: organization
1880
1881 - `spend_limit_id: string`
1882
1883 - `status: "approved" or "denied" or "pending"`
1884
1885 - `"approved"`
1886
1887 - `"denied"`
1888
1889 - `"pending"`
18902350
api/beta/organization/spend_limits/increase_requests/approve Changed · +131 / -45 lines
from line 170
170170
171171 - `"weekly"`
172172
173 - `scope: User or SeatTier or RBACGroup or 2 more`
173 - `scope: User or SeatTier or RBACGroup or 3 more`
174174
175175 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
176176
from line 218
218218
219219 default: organization
220220
221 - `Workspace object`
222
223 Scope selecting one workspace of a Claude Console organization.
224
225 - `type: "workspace"`
226
227 Scope type. Always `workspace` for this scope.
228
229 default: workspace
230
231 - `workspace_id: string`
232
233 Tagged ID of the workspace the spend limit applies to.
234
221235 - `updated_at: string`
222236
223237 RFC 3339 datetime at which the spend limit was last modified.
from line 242
228242
229243 Per-member effective-limit report row (`GET /spend_limits/effective`).
230244
231 - `actor: object`
245 - `actor: UserActor or ScopedAPIKeyActor`
232246
233 A user within the organization. `name` and `email_address` are
234 null when the underlying account is unavailable or has been deleted;
235 `deleted` is true only for deleted accounts.
247 - `UserActor object`
236248
237 - `type: "user_actor"`
249 A user within the organization. `name` and `email_address` are
250 null when the underlying account is unavailable or has been deleted;
251 `deleted` is true only for deleted accounts.
238252
239 Actor type. Always `user_actor`.
253 - `type: "user_actor"`
240254
241 default: user_actor
255 Actor type. Always `user_actor`.
242256
243 - `deleted: boolean`
257 default: user_actor
244258
245 True only when the underlying account has been deleted.
259 - `deleted: boolean`
246260
247 default: false
261 True only when the underlying account has been deleted.
248262
249 - `email_address: string or null`
263 default: false
250264
251 The user's email address. Null when the account is unavailable or has been deleted.
265 - `email_address: string or null`
252266
253 - `name: string or null`
267 The user's email address. Null when the account is unavailable or has been deleted.
254268
255 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
269 - `name: string or null`
256270
257 - `user_id: string`
271 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
258272
259 Tagged ID of the user.
273 - `user_id: string`
260274
275 Tagged ID of the user.
276
277 - `ScopedAPIKeyActor object`
278
279 A scoped Admin API key acting on behalf of the organization.
280
281 - `type: "scoped_api_key_actor"`
282
283 default: scoped_api_key_actor
284
285 - `scoped_api_key_id: string`
286
261287 - `amount: string or null`
262288
263289 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 306
280306
281307 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.
282308
283 - `scope: object`
309 - `scope: User or SeatTier or RBACGroup or 3 more`
284310
285 Scope selecting a single member of the organization.
311 - `User object`
286312
287 - `type: "user"`
313 Scope selecting a single member of the organization.
288314
289 Scope type. Always `user` for this scope.
315 - `type: "user"`
290316
291 default: user
317 Scope type. Always `user` for this scope.
292318
293 - `user_id: string`
319 default: user
294320
295 Tagged ID of the member the spend limit applies to.
321 - `user_id: string`
296322
297 - `source: User or SeatTier or RBACGroup or 2 more`
323 Tagged ID of the member the spend limit applies to.
298324
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
357 Scope selecting one workspace of a Claude Console organization.
358
359 - `type: "workspace"`
360
361 Scope type. Always `workspace` for this scope.
362
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
299371 - `User object`
300372
301373 Scope selecting a single member of the organization.
from line 411
339411 - `type: "organization"`
340412
341413 default: organization
414
415 - `Workspace object`
416
417 Scope selecting one workspace of a Claude Console organization.
418
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.
342428
343429 - `spend_limit_id: string`
344430
api/beta/organization/spend_limits/increase_requests/deny Changed · +116 / -44 lines
from line 124
124124
125125 Per-member effective-limit report row (`GET /spend_limits/effective`).
126126
127 - `actor: object`
127 - `actor: UserActor or ScopedAPIKeyActor`
128128
129 A user within the organization. `name` and `email_address` are
130 null when the underlying account is unavailable or has been deleted;
131 `deleted` is true only for deleted accounts.
129 - `UserActor object`
132130
133 - `type: "user_actor"`
131 A user within the organization. `name` and `email_address` are
132 null when the underlying account is unavailable or has been deleted;
133 `deleted` is true only for deleted accounts.
134134
135 Actor type. Always `user_actor`.
135 - `type: "user_actor"`
136136
137 default: user_actor
137 Actor type. Always `user_actor`.
138138
139 - `deleted: boolean`
139 default: user_actor
140140
141 True only when the underlying account has been deleted.
141 - `deleted: boolean`
142142
143 default: false
143 True only when the underlying account has been deleted.
144144
145 - `email_address: string or null`
145 default: false
146146
147 The user's email address. Null when the account is unavailable or has been deleted.
147 - `email_address: string or null`
148148
149 - `name: string or null`
149 The user's email address. Null when the account is unavailable or has been deleted.
150150
151 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
151 - `name: string or null`
152152
153 - `user_id: string`
153 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
154154
155 Tagged ID of the user.
155 - `user_id: string`
156156
157 Tagged ID of the user.
158
159 - `ScopedAPIKeyActor object`
160
161 A scoped Admin API key acting on behalf of the organization.
162
163 - `type: "scoped_api_key_actor"`
164
165 default: scoped_api_key_actor
166
167 - `scoped_api_key_id: string`
168
157169 - `amount: string or null`
158170
159171 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 188
176188
177189 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.
178190
179 - `scope: object`
191 - `scope: User or SeatTier or RBACGroup or 3 more`
180192
181 Scope selecting a single member of the organization.
193 - `User object`
182194
183 - `type: "user"`
195 Scope selecting a single member of the organization.
184196
185 Scope type. Always `user` for this scope.
197 - `type: "user"`
186198
187 default: user
199 Scope type. Always `user` for this scope.
188200
189 - `user_id: string`
201 default: user
190202
191 Tagged ID of the member the spend limit applies to.
203 - `user_id: string`
192204
193 - `source: User or SeatTier or RBACGroup or 2 more`
205 Tagged ID of the member the spend limit applies to.
194206
207 - `SeatTier object`
208
209 - `type: "seat_tier"`
210
211 default: seat_tier
212
213 - `seat_tier: string`
214
215 - `RBACGroup object`
216
217 - `type: "rbac_group"`
218
219 default: rbac_group
220
221 - `rbac_group_id: string`
222
223 - `OrganizationService object`
224
225 - `type: "organization_service"`
226
227 default: organization_service
228
229 - `service: string`
230
231 - `Organization object`
232
233 - `type: "organization"`
234
235 default: organization
236
237 - `Workspace object`
238
239 Scope selecting one workspace of a Claude Console organization.
240
241 - `type: "workspace"`
242
243 Scope type. Always `workspace` for this scope.
244
245 default: workspace
246
247 - `workspace_id: string`
248
249 Tagged ID of the workspace the spend limit applies to.
250
251 - `source: User or SeatTier or RBACGroup or 3 more`
252
195253 - `User object`
196254
197255 Scope selecting a single member of the organization.
from line 293
235293 - `type: "organization"`
236294
237295 default: organization
296
297 - `Workspace object`
298
299 Scope selecting one workspace of a Claude Console organization.
300
301 - `type: "workspace"`
302
303 Scope type. Always `workspace` for this scope.
304
305 default: workspace
306
307 - `workspace_id: string`
308
309 Tagged ID of the workspace the spend limit applies to.
238310
239311 - `spend_limit_id: string`
240312
api/beta/organization/spend_limits/increase_requests/list Changed · +116 / -44 lines
from line 138
138138
139139 Per-member effective-limit report row (`GET /spend_limits/effective`).
140140
141 - `actor: object`
141 - `actor: UserActor or ScopedAPIKeyActor`
142142
143 A user within the organization. `name` and `email_address` are
144 null when the underlying account is unavailable or has been deleted;
145 `deleted` is true only for deleted accounts.
143 - `UserActor object`
146144
147 - `type: "user_actor"`
145 A user within the organization. `name` and `email_address` are
146 null when the underlying account is unavailable or has been deleted;
147 `deleted` is true only for deleted accounts.
148148
149 Actor type. Always `user_actor`.
149 - `type: "user_actor"`
150150
151 default: user_actor
151 Actor type. Always `user_actor`.
152152
153 - `deleted: boolean`
153 default: user_actor
154154
155 True only when the underlying account has been deleted.
155 - `deleted: boolean`
156156
157 default: false
157 True only when the underlying account has been deleted.
158158
159 - `email_address: string or null`
159 default: false
160160
161 The user's email address. Null when the account is unavailable or has been deleted.
161 - `email_address: string or null`
162162
163 - `name: string or null`
163 The user's email address. Null when the account is unavailable or has been deleted.
164164
165 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
165 - `name: string or null`
166166
167 - `user_id: string`
167 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
168168
169 Tagged ID of the user.
169 - `user_id: string`
170170
171 Tagged ID of the user.
172
173 - `ScopedAPIKeyActor object`
174
175 A scoped Admin API key acting on behalf of the organization.
176
177 - `type: "scoped_api_key_actor"`
178
179 default: scoped_api_key_actor
180
181 - `scoped_api_key_id: string`
182
171183 - `amount: string or null`
172184
173185 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 202
190202
191203 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.
192204
193 - `scope: object`
205 - `scope: User or SeatTier or RBACGroup or 3 more`
194206
195 Scope selecting a single member of the organization.
207 - `User object`
196208
197 - `type: "user"`
209 Scope selecting a single member of the organization.
198210
199 Scope type. Always `user` for this scope.
211 - `type: "user"`
200212
201 default: user
213 Scope type. Always `user` for this scope.
202214
203 - `user_id: string`
215 default: user
204216
205 Tagged ID of the member the spend limit applies to.
217 - `user_id: string`
206218
207 - `source: User or SeatTier or RBACGroup or 2 more`
219 Tagged ID of the member the spend limit applies to.
208220
221 - `SeatTier object`
222
223 - `type: "seat_tier"`
224
225 default: seat_tier
226
227 - `seat_tier: string`
228
229 - `RBACGroup object`
230
231 - `type: "rbac_group"`
232
233 default: rbac_group
234
235 - `rbac_group_id: string`
236
237 - `OrganizationService object`
238
239 - `type: "organization_service"`
240
241 default: organization_service
242
243 - `service: string`
244
245 - `Organization object`
246
247 - `type: "organization"`
248
249 default: organization
250
251 - `Workspace object`
252
253 Scope selecting one workspace of a Claude Console organization.
254
255 - `type: "workspace"`
256
257 Scope type. Always `workspace` for this scope.
258
259 default: workspace
260
261 - `workspace_id: string`
262
263 Tagged ID of the workspace the spend limit applies to.
264
265 - `source: User or SeatTier or RBACGroup or 3 more`
266
209267 - `User object`
210268
211269 Scope selecting a single member of the organization.
from line 307
249307 - `type: "organization"`
250308
251309 default: organization
310
311 - `Workspace object`
312
313 Scope selecting one workspace of a Claude Console organization.
314
315 - `type: "workspace"`
316
317 Scope type. Always `workspace` for this scope.
318
319 default: workspace
320
321 - `workspace_id: string`
322
323 Tagged ID of the workspace the spend limit applies to.
252324
253325 - `spend_limit_id: string`
254326
api/beta/organization/spend_limits/increase_requests/retrieve Changed · +116 / -44 lines
from line 120
120120
121121 Per-member effective-limit report row (`GET /spend_limits/effective`).
122122
123 - `actor: object`
123 - `actor: UserActor or ScopedAPIKeyActor`
124124
125 A user within the organization. `name` and `email_address` are
126 null when the underlying account is unavailable or has been deleted;
127 `deleted` is true only for deleted accounts.
125 - `UserActor object`
128126
129 - `type: "user_actor"`
127 A user within the organization. `name` and `email_address` are
128 null when the underlying account is unavailable or has been deleted;
129 `deleted` is true only for deleted accounts.
130130
131 Actor type. Always `user_actor`.
131 - `type: "user_actor"`
132132
133 default: user_actor
133 Actor type. Always `user_actor`.
134134
135 - `deleted: boolean`
135 default: user_actor
136136
137 True only when the underlying account has been deleted.
137 - `deleted: boolean`
138138
139 default: false
139 True only when the underlying account has been deleted.
140140
141 - `email_address: string or null`
141 default: false
142142
143 The user's email address. Null when the account is unavailable or has been deleted.
143 - `email_address: string or null`
144144
145 - `name: string or null`
145 The user's email address. Null when the account is unavailable or has been deleted.
146146
147 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
147 - `name: string or null`
148148
149 - `user_id: string`
149 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
150150
151 Tagged ID of the user.
151 - `user_id: string`
152152
153 Tagged ID of the user.
154
155 - `ScopedAPIKeyActor object`
156
157 A scoped Admin API key acting on behalf of the organization.
158
159 - `type: "scoped_api_key_actor"`
160
161 default: scoped_api_key_actor
162
163 - `scoped_api_key_id: string`
164
153165 - `amount: string or null`
154166
155167 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 184
172184
173185 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.
174186
175 - `scope: object`
187 - `scope: User or SeatTier or RBACGroup or 3 more`
176188
177 Scope selecting a single member of the organization.
189 - `User object`
178190
179 - `type: "user"`
191 Scope selecting a single member of the organization.
180192
181 Scope type. Always `user` for this scope.
193 - `type: "user"`
182194
183 default: user
195 Scope type. Always `user` for this scope.
184196
185 - `user_id: string`
197 default: user
186198
187 Tagged ID of the member the spend limit applies to.
199 - `user_id: string`
188200
189 - `source: User or SeatTier or RBACGroup or 2 more`
201 Tagged ID of the member the spend limit applies to.
190202
203 - `SeatTier object`
204
205 - `type: "seat_tier"`
206
207 default: seat_tier
208
209 - `seat_tier: string`
210
211 - `RBACGroup object`
212
213 - `type: "rbac_group"`
214
215 default: rbac_group
216
217 - `rbac_group_id: string`
218
219 - `OrganizationService object`
220
221 - `type: "organization_service"`
222
223 default: organization_service
224
225 - `service: string`
226
227 - `Organization object`
228
229 - `type: "organization"`
230
231 default: organization
232
233 - `Workspace object`
234
235 Scope selecting one workspace of a Claude Console organization.
236
237 - `type: "workspace"`
238
239 Scope type. Always `workspace` for this scope.
240
241 default: workspace
242
243 - `workspace_id: string`
244
245 Tagged ID of the workspace the spend limit applies to.
246
247 - `source: User or SeatTier or RBACGroup or 3 more`
248
191249 - `User object`
192250
193251 Scope selecting a single member of the organization.
from line 289
231289 - `type: "organization"`
232290
233291 default: organization
292
293 - `Workspace object`
294
295 Scope selecting one workspace of a Claude Console organization.
296
297 - `type: "workspace"`
298
299 Scope type. Always `workspace` for this scope.
300
301 default: workspace
302
303 - `workspace_id: string`
304
305 Tagged ID of the workspace the spend limit applies to.
234306
235307 - `spend_limit_id: string`
236308
api/beta/organization/spend_limits/list_effective Changed · +116 / -44 lines
from line 47
4747
4848- `data: array of BetaSpendSummary`
4949
50 - `actor: object`
50 - `actor: UserActor or ScopedAPIKeyActor`
5151
52 A user within the organization. `name` and `email_address` are
53 null when the underlying account is unavailable or has been deleted;
54 `deleted` is true only for deleted accounts.
52 - `UserActor object`
5553
56 - `type: "user_actor"`
54 A user within the organization. `name` and `email_address` are
55 null when the underlying account is unavailable or has been deleted;
56 `deleted` is true only for deleted accounts.
5757
58 Actor type. Always `user_actor`.
58 - `type: "user_actor"`
5959
60 default: user_actor
60 Actor type. Always `user_actor`.
6161
62 - `deleted: boolean`
62 default: user_actor
6363
64 True only when the underlying account has been deleted.
64 - `deleted: boolean`
6565
66 default: false
66 True only when the underlying account has been deleted.
6767
68 - `email_address: string or null`
68 default: false
6969
70 The user's email address. Null when the account is unavailable or has been deleted.
70 - `email_address: string or null`
7171
72 - `name: string or null`
72 The user's email address. Null when the account is unavailable or has been deleted.
7373
74 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
74 - `name: string or null`
7575
76 - `user_id: string`
76 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.
7777
78 Tagged ID of the user.
78 - `user_id: string`
7979
80 Tagged ID of the user.
81
82 - `ScopedAPIKeyActor object`
83
84 A scoped Admin API key acting on behalf of the organization.
85
86 - `type: "scoped_api_key_actor"`
87
88 default: scoped_api_key_actor
89
90 - `scoped_api_key_id: string`
91
8092 - `amount: string or null`
8193
8294 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 111
99111
100112 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.
101113
102 - `scope: object`
114 - `scope: User or SeatTier or RBACGroup or 3 more`
103115
104 Scope selecting a single member of the organization.
116 - `User object`
105117
106 - `type: "user"`
118 Scope selecting a single member of the organization.
107119
108 Scope type. Always `user` for this scope.
120 - `type: "user"`
109121
110 default: user
122 Scope type. Always `user` for this scope.
111123
112 - `user_id: string`
124 default: user
113125
114 Tagged ID of the member the spend limit applies to.
126 - `user_id: string`
115127
116 - `source: User or SeatTier or RBACGroup or 2 more`
128 Tagged ID of the member the spend limit applies to.
117129
130 - `SeatTier object`
131
132 - `type: "seat_tier"`
133
134 default: seat_tier
135
136 - `seat_tier: string`
137
138 - `RBACGroup object`
139
140 - `type: "rbac_group"`
141
142 default: rbac_group
143
144 - `rbac_group_id: string`
145
146 - `OrganizationService object`
147
148 - `type: "organization_service"`
149
150 default: organization_service
151
152 - `service: string`
153
154 - `Organization object`
155
156 - `type: "organization"`
157
158 default: organization
159
160 - `Workspace object`
161
162 Scope selecting one workspace of a Claude Console organization.
163
164 - `type: "workspace"`
165
166 Scope type. Always `workspace` for this scope.
167
168 default: workspace
169
170 - `workspace_id: string`
171
172 Tagged ID of the workspace the spend limit applies to.
173
174 - `source: User or SeatTier or RBACGroup or 3 more`
175
118176 - `User object`
119177
120178 Scope selecting a single member of the organization.
from line 216
158216 - `type: "organization"`
159217
160218 default: organization
219
220 - `Workspace object`
221
222 Scope selecting one workspace of a Claude Console organization.
223
224 - `type: "workspace"`
225
226 Scope type. Always `workspace` for this scope.
227
228 default: workspace
229
230 - `workspace_id: string`
231
232 Tagged ID of the workspace the spend limit applies to.
161233
162234 - `spend_limit_id: string`
163235
api/beta/organization/spend_limits/retrieve Changed · +15 / -1 lines
from line 55
5555
5656 - `"weekly"`
5757
58 - `scope: User or SeatTier or RBACGroup or 2 more`
58 - `scope: User or SeatTier or RBACGroup or 3 more`
5959
6060 What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope.
6161
from line 102
102102 - `type: "organization"`
103103
104104 default: organization
105
106 - `Workspace object`
107
108 Scope selecting one workspace of a Claude Console organization.
109
110 - `type: "workspace"`
111
112 Scope type. Always `workspace` for this scope.
113
114 default: workspace
115
116 - `workspace_id: string`
117
118 Tagged ID of the workspace the spend limit applies to.
105119
106120 - `updated_at: string`
107121
api/compliance Changed · +6203 / -5695 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 19
1919
2020#### Query parameters
2121
22- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 501 more`
22- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 503 more`
2323
2424 Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.
2525
from line 823
823823
824824 Webhook signature validation failed.
825825
826 - `"github_app_installation_linked"`
827
828 An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
829
830 - `"github_app_installation_unlinked"`
831
832 An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
833
826834 - `"github_token_import"`
827835
828836 A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
from line 2102
20942102
20952103 format: date-time
20962104
2097- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 501 more`
2105- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 503 more`
20982106
20992107 Exclude activities of these types. Cannot be combined with `activity_types[]`.
21002108
from line 2906
28982906
28992907 Webhook signature validation failed.
29002908
2909 - `"github_app_installation_linked"`
2910
2911 An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
2912
2913 - `"github_app_installation_unlinked"`
2914
2915 An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
2916
29012917 - `"github_token_import"`
29022918
29032919 A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
from line 4177
41614177
41624178#### Returns
41634179
4164- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 501 more`
4180- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 503 more`
41654181
41664182 List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present.
41674183
from line 9888
98729888
98739889 - `ip_address: string`
98749890
9875 - `user_agent: string`
9876
9877 - `ServiceAccountActor object`
9878
9879 - `type: optional "service_account_actor"`
9880
9881 default: service_account_actor
9882
9883 - `ip_address: string`
9884
9885 - `service_account_id: string`
9886
9887 - `user_agent: string`
9888
9889 - `ScimDirectorySyncActor object`
9890
9891 - `type: optional "scim_directory_sync_actor"`
9892
9893 default: scim_directory_sync_actor
9894
9895 - `directory_id: string`
9896
9897 - `workos_event_id: string`
9898
9899 - `idp_connection_type: optional string or null`
9900
9901 - `FederatedIdentityActor object`
9902
9903 A federated external workload authenticated via a verified OIDC token.
9904
9905 Carries the verified issuer, subject, and audience claims from the
9906 presented JWT.
9907
9908 - `type: optional "federated_identity_actor"`
9909
9910 default: federated_identity_actor
9911
9912 - `issuer: string`
9913
9914 - `subject: string`
9915
9916 - `audience: optional array of string`
9917
9918 - `ip_address: optional string or null`
9919
9920 - `user_agen
9891 - `u
api/compliance/activities Changed · +12388 / -11388 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 17
1717
1818### Query parameters
1919
20- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 501 more`
20- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 503 more`
2121
2222 Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.
2323
from line 821
821821
822822 Webhook signature validation failed.
823823
824 - `"github_app_installation_linked"`
825
826 An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
827
828 - `"github_app_installation_unlinked"`
829
830 An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
831
824832 - `"github_token_import"`
825833
826834 A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
from line 2100
20922100
20932101 format: date-time
20942102
2095- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 501 more`
2103- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 503 more`
20962104
20972105 Exclude activities of these types. Cannot be combined with `activity_types[]`.
20982106
from line 2904
28962904
28972905 Webhook signature validation failed.
28982906
2907 - `"github_app_installation_linked"`
2908
2909 An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
2910
2911 - `"github_app_installation_unlinked"`
2912
2913 An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
2914
28992915 - `"github_token_import"`
29002916
29012917 A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
from line 4175
41594175
41604176### Returns
41614177
4162- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 501 more`
4178- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 503 more`
41634179
41644180 List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present.
41654181
from line 9888
98729888
98739889 - `user_agent: string`
98749890
9875 - `ServiceAccountActor object`
9876
9877 - `type: optional "service_account_actor"`
9878
9879 default: service_account_actor
9880
9881 - `ip_address: string`
9882
9883 - `service_account_id: string`
9884
9885 - `user_agent: string`
9886
9887 - `ScimDirectorySyncActor object`
9888
9889 - `type: optional "scim_directory_sync_actor"`
9890
9891 default: scim_directory_sync_actor
9892
9893 - `directory_id: string`
9894
9895 - `workos_event_id: string`
9896
9897 - `idp_connection_type: optional string or null`
9898
9899 - `FederatedIdentityActor object`
9900
9901 A federated external workload authenticated via a verified OIDC token.
9902
9903 Carries the verified issuer, subject, and audience claims from the
9904 presented JWT.
9905
9906 - `type: optional "federated_identity_actor"`
9907
9908 default: federated_identity_actor
9909
9910 - `issuer: string`
9911
9912 - `subject: string`
9913
9914 - `audience: optional array of string`
9915
9916 - `ip_address: optional string or null`
9917
9918 - `user_agent: optional string or null`
9919
9920
9891 - `Servic
api/compliance/activities/list Changed · +6203 / -5695 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 15
1515
1616## Query parameters
1717
18- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 501 more`
18- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 503 more`
1919
2020 Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.
2121
from line 819
819819
820820 Webhook signature validation failed.
821821
822 - `"github_app_installation_linked"`
823
824 An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
825
826 - `"github_app_installation_unlinked"`
827
828 An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
829
822830 - `"github_token_import"`
823831
824832 A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
from line 2098
20902098
20912099 format: date-time
20922100
2093- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 501 more`
2101- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 503 more`
20942102
20952103 Exclude activities of these types. Cannot be combined with `activity_types[]`.
20962104
from line 2902
28942902
28952903 Webhook signature validation failed.
28962904
2905 - `"github_app_installation_linked"`
2906
2907 An installation of the Claude GitHub App (a GitHub organization or user account where the App is installed) was linked to the organization, letting the organization's Claude Code features act on that GitHub account's repositories.
2908
2909 - `"github_app_installation_unlinked"`
2910
2911 An installation of the Claude GitHub App was unlinked from the organization, so the organization's Claude Code features can no longer act on that GitHub account's repositories through it.
2912
28972913 - `"github_token_import"`
28982914
28992915 A user attempted to import a personal GitHub access token for use with Claude Code. The `result` field indicates the outcome of the import (imported, rejected, or failed).
from line 4173
41574173
41584174## Returns
41594175
4160- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 501 more`
4176- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 503 more`
41614177
41624178 List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present.
41634179
from line 9886
98709886
98719887 - `user_agent: string`
98729888
9873 - `ServiceAccountActor object`
9874
9875 - `type: optional "service_account_actor"`
9876
9877 default: service_account_actor
9878
9879 - `ip_address: string`
9880
9881 - `service_account_id: string`
9882
9883 - `user_agent: string`
9884
9885 - `ScimDirectorySyncActor object`
9886
9887 - `type: optional "scim_directory_sync_actor"`
9888
9889 default: scim_directory_sync_actor
9890
9891 - `directory_id: string`
9892
9893 - `workos_event_id: string`
9894
9895 - `idp_connection_type: optional string or null`
9896
9897 - `FederatedIdentityActor object`
9898
9899 A federated external workload authenticated via a verified OIDC token.
9900
9901 Carries the verified issuer, subject, and audience claims from the
9902 presented JWT.
9903
9904 - `type: optional "federated_identity_actor"`
9905
9906 default: federated_identity_actor
9907
9908 - `issuer: string`
9909
9910 - `subject: string`
9911
9912 - `audience: optional array of string`
9913
9914 - `ip_address: optional string or null`
9915
9916 - `user_agent: optional string or null`
9917
9918
9889 - `Se
build-with-claude/claude-in-microsoft-foundry Changed · +12 / -12 lines
from line 676
676676The following Claude models are available through Foundry:
677677
678678| Model | Default deployment name | Hosted on Azure | Hosted on Anthropic |
679| ----------------- | ----------------------- | --------------- | ------------------- |
680| Claude Fable 5.1 | claude-fable-5-1 | | ✓ |
681| Claude Fable 5 | claude-fable-5 | | ✓ |
682| Claude Opus 5 | claude-opus-5 | ✓ | ✓ |
683| Claude Opus 4.8 | claude-opus-4-8 | ✓ | ✓ |
684| Claude Opus 4.7 | claude-opus-4-7 | | ✓ |
685| Claude Opus 4.6 | claude-opus-4-6 | | ✓ |
686| Claude Opus 4.5 | claude-opus-4-5 | | ✓ |
687| Claude Sonnet 5 | claude-sonnet-5 | ✓ | ✓ |
688| Claude Sonnet 4.6 | claude-sonnet-4-6 | | ✓ |
689| Claude Sonnet 4.5 | claude-sonnet-4-5 | | ✓ |
690| Claude Haiku 4.5 | claude-haiku-4-5 | ✓ | ✓ |
679| :---------------- | :---------------------- | :-------------: | :-----------------: |
680| Claude Fable 5.1 | `claude-fable-5-1` | | ✓ |
681| Claude Fable 5 | `claude-fable-5` | | ✓ |
682| Claude Opus 5 | `claude-opus-5` | ✓ | ✓ |
683| Claude Opus 4.8 | `claude-opus-4-8` | ✓ | ✓ |
684| Claude Opus 4.7 | `claude-opus-4-7` | | ✓ |
685| Claude Opus 4.6 | `claude-opus-4-6` | | ✓ |
686| Claude Opus 4.5 | `claude-opus-4-5` | | ✓ |
687| Claude Sonnet 5 | `claude-sonnet-5` | ✓ | ✓ |
688| Claude Sonnet 4.6 | `claude-sonnet-4-6` | | ✓ |
689| Claude Sonnet 4.5 | `claude-sonnet-4-5` | | ✓ |
690| Claude Haiku 4.5 | `claude-haiku-4-5` | ✓ | ✓ |
691691
692692By default, deployment names match the model IDs shown in the preceding table. However, you can create custom deployments with different names in the Foundry portal to manage different configurations, versions, or rate limits. Use the deployment name (not necessarily the model ID) in your API requests.
693693
build-with-claude/claude-on-vertex-ai Changed · +17 / -18 lines
from line 115
115115
116116Lifecycle terms (Deprecated, Retired) are defined in [Model deprecations](https://platform.claude.com/docs/en/about-claude/model-deprecations). Lifecycle dates on partner-operated platforms are set by the partner and can differ from the Claude API schedule. For the current retirement date of any model on Agent Platform, see [Google Cloud's documentation for Claude models on Agent Platform](https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/partner-models/claude).
117117
118| Model | Agent Platform API model ID |
119| ---------------------------- | --------------------------- |
120| Claude Fable 5.1 | claude-fable-5-1 |
121| Claude Fable 5 | claude-fable-5 |
122| Claude Opus 5 | claude-opus-5 |
123| Claude Opus 4.8 | claude-opus-4-8 |
124| Claude Opus 4.7 | claude-opus-4-7 |
125| Claude Opus 4.6 | claude-opus-4-6 |
126| Claude Sonnet 5 | `claude-sonnet-5` |
127| Claude Sonnet 4.6 | claude-sonnet-4-6 |
128| Claude Sonnet 4.5 | claude-sonnet-4-5\@20250929 |
129| Claude Sonnet 4 Deprecated. | claude-sonnet-4\@20250514 |
130| Claude Sonnet 3.7 Retired. | claude-3-7-sonnet\@20250219 |
131| Claude Opus 4.5 | claude-opus-4-5\@20251101 |
132| Claude Opus 4.1 Deprecated. | claude-opus-4-1\@20250805 |
133| Claude Opus 4 Deprecated. | claude-opus-4\@20250514 |
134| Claude Haiku 4.5 | claude-haiku-4-5\@20251001 |
135| Claude Haiku 3.5 Deprecated. | claude-3-5-haiku\@20241022 |
118| Model | Agent Platform API model ID |
119| :--------------------------------------------------------------------------------------------------- | :--------------------------- |
120| Claude Fable 5.1 | `claude-fable-5-1` |
121| Claude Fable 5 | `claude-fable-5` |
122| Claude Opus 5 | `claude-opus-5` |
123| Claude Opus 4.8 | `claude-opus-4-8` |
124| Claude Opus 4.7 | `claude-opus-4-7` |
125| Claude Opus 4.6 | `claude-opus-4-6` |
126| Claude Opus 4.5 | `claude-opus-4-5@20251101` |
127| Claude Opus 4.1 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations)) | `claude-opus-4-1@20250805` |
128| Claude Opus 4 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations)) | `claude-opus-4@20250514` |
129| Claude Sonnet 5 | `claude-sonnet-5` |
130| Claude Sonnet 4.6 | `claude-sonnet-4-6` |
131| Claude Sonnet 4.5 | `claude-sonnet-4-5@20250929` |
132| Claude Sonnet 4 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations)) | `claude-sonnet-4@20250514` |
133| Claude Haiku 4.5 | `claude-haiku-4-5@20251001` |
134| Claude Haiku 3.5 ([deprecated](https://platform.claude.com/docs/en/about-claude/model-deprecations)) | `claude-3-5-haiku@20241022` |
136135
137136<Tip>
138137 Upgrading to a newer Claude model? In Claude Code, run `/claude-api migrate` to apply model ID swaps and breaking parameter changes across your codebase. The skill detects which cloud platform your code targets and adjusts model ID formats and feature changes for that platform. See [Migrating to a newer Claude model](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/claude-api-skill#migrating-to-a-newer-claude-model).
build-with-claude/claude-platform-on-aws Changed · +15 / -15 lines
from line 14
1414
1515Claude models run on Anthropic-managed infrastructure. This is a commercial integration for billing and access through AWS. Anthropic is the data processor for inference inputs and outputs. AWS processes billing and identity metadata under the marketplace model. Customers using Claude through Claude Platform on AWS are subject to Anthropic's [data use terms](https://www.anthropic.com/legal).
1616
17Claude Platform on AWS has the following operational characteristics: data might not reside in AWS, inference might route to Anthropic's primary cloud, and subservices might change without notice. Set the [`inference_geo`](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#data-residency) parameter per request to pin inference to a specific geography.
17Anthropic uses AWS infrastructure to process your API requests, run model inference, and store your workspace content (such as prompts, outputs, files, Skills, and batches). For workspaces created before September 18, 2026, 00:00 UTC, Anthropic might process requests, store data, and run inference outside AWS. In either case, subservices might change without notice. Set the [`inference_geo`](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#data-residency) parameter per request to pin inference to a specific geography.
1818
1919Claude Platform on AWS follows the same data retention policy as the first-party Claude API. Zero Data Retention (ZDR) is available on request. Contact your Anthropic account representative to enable it for your organization.
2020
from line 72
7272 If your organization has a private offer from Anthropic, the Console looks it up and prompts you to accept it in AWS Marketplace. See [Private offers](https://platform.claude.com/docs/en/about-claude/pricing#private-offers) for details.
7373
7474 <Note>
75 If you use Claude Platform on AWS, your content (such as prompts and completions) is processed by Anthropic outside of AWS. See Anthropic's [data use policies](https://www.anthropic.com/legal) for details on how content and metadata are processed and stored.
75 When you use Claude Platform on AWS, Anthropic processes and stores your content (such as prompts and outputs) on AWS infrastructure. For workspaces created before September 18, 2026, 00:00 UTC, Anthropic might process and store that content outside AWS. Anthropic's [data use policies](https://www.anthropic.com/legal) describe how content and metadata are processed and stored.
7676 </Note>
7777 </Step>
7878
from line 344
344344
345345The following models are available on Claude Platform on AWS:
346346
347| Model | Model ID |
348| :---------------- | :---------------- |
349| Claude Fable 5.1 | claude-fable-5-1 |
350| Claude Fable 5 | claude-fable-5 |
351| Claude Opus 5 | claude-opus-5 |
352| Claude Opus 4.8 | claude-opus-4-8 |
353| Claude Opus 4.7 | claude-opus-4-7 |
354| Claude Opus 4.6 | claude-opus-4-6 |
355| Claude Opus 4.5 | claude-opus-4-5 |
356| Claude Sonnet 5 | claude-sonnet-5 |
357| Claude Sonnet 4.6 | claude-sonnet-4-6 |
358| Claude Sonnet 4.5 | claude-sonnet-4-5 |
359| Claude Haiku 4.5 | claude-haiku-4-5 |
347| Model | Model ID |
348| :---------------- | :------------------ |
349| Claude Fable 5.1 | `claude-fable-5-1` |
350| Claude Fable 5 | `claude-fable-5` |
351| Claude Opus 5 | `claude-opus-5` |
352| Claude Opus 4.8 | `claude-opus-4-8` |
353| Claude Opus 4.7 | `claude-opus-4-7` |
354| Claude Opus 4.6 | `claude-opus-4-6` |
355| Claude Opus 4.5 | `claude-opus-4-5` |
356| Claude Sonnet 5 | `claude-sonnet-5` |
357| Claude Sonnet 4.6 | `claude-sonnet-4-6` |
358| Claude Sonnet 4.5 | `claude-sonnet-4-5` |
359| Claude Haiku 4.5 | `claude-haiku-4-5` |
360360
361361Model IDs are identical to the first-party Claude API. There are no Bedrock-style ARNs or `anthropic.` prefixes.
362362
build-with-claude/refusals-and-fallback Changed · +4 / -6 lines
from line 29
2929 "max_tokens": 1024,
3030 "fallbacks": "default",
3131 "messages": [{"role": "user", "content": "Hello, Claude"}]
32 }' | jq -r '.model'
32 }'
3333 ```
3434
3535 ```bash CLI
from line 38
3838 --max-tokens 1024 \
3939 --message '{"role":"user","content":"Hello, Claude"}' \
4040 --fallbacks default \
41 --beta server-side-fallback-2026-07-01 \
42 --transform model --raw-output
41 --beta server-side-fallback-2026-07-01
4342 ```
4443
4544 ```python Python
from line 503
504503 "max_tokens": 1024,
505504 "fallbacks": [{"model": "claude-opus-4-8"}],
506505 "messages": [{"role": "user", "content": "Hello, Claude"}]
507 }' | jq -r '.model'
506 }'
508507 ```
509508
510509 ```bash CLI
from line 512
513512 --max-tokens 1024 \
514513 --message '{"role":"user","content":"Hello, Claude"}' \
515514 --fallbacks '[{"model":"claude-opus-4-8"}]' \
516 --beta server-side-fallback-2026-07-01 \
517 --transform model --raw-output
515 --beta server-side-fallback-2026-07-01
518516 ```
519517
520518 ```python Python
build-with-claude/skills-guide Changed · +5 / -5 lines
from line 2166
21662166
21672167Files are identified by the filename you attach (the `;filename=` suffix in the cURL example and the filename arguments in the SDK examples). For the walkthrough's skill, create a zip with `zip -r financial_skill.zip financial_skill/` and substitute it for the `example_skill.zip` placeholder in the zip-upload options.
21682168
2169<CodeGroup defaultLanguage="CLI">
2169<CodeGroup>
21702170 ```bash cURL
21712171 curl -X POST "https://api.anthropic.com/v1/skills" \
21722172 -H "x-api-key: $ANTHROPIC_API_KEY" \
from line 2471
24712471
24722472Retrieve all Skills available to your workspace, including both Anthropic pre-built Skills and your custom Skills. Use the `source` parameter to filter by skill type:
24732473
2474<CodeGroup defaultLanguage="CLI">
2474<CodeGroup>
24752475 ```bash cURL
24762476 # List all Skills
24772477 curl "https://api.anthropic.com/v1/skills" \
from line 2617
26172617
26182618Get details about a specific Skill:
26192619
2620<CodeGroup defaultLanguage="CLI">
2620<CodeGroup>
26212621 ```bash cURL
26222622 curl "https://api.anthropic.com/v1/skills/skill_01AbCdEfGhIjKlMnOpQrStUv" \
26232623 -H "x-api-key: $ANTHROPIC_API_KEY" \
from line 2714
27142714
27152715Deleting a Skill also removes all of its versions.
27162716
2717<CodeGroup defaultLanguage="CLI">
2717<CodeGroup>
27182718 ```bash cURL
27192719 curl -X DELETE "https://api.anthropic.com/v1/skills/skill_01AbCdEfGhIjKlMnOpQrStUv" \
27202720 -H "x-api-key: $ANTHROPIC_API_KEY" \
from line 2795
27952795
27962796A new version is a complete snapshot, not a delta: upload the Skill's full file set each time. Files you omit are not carried over, and the `name` in the new version's `SKILL.md` must match the Skill's existing name. The following examples re-upload the complete `financial_skill/` bundle from [Creating a Skill](https://platform.claude.com/docs/en/build-with-claude/skills-guide#creating-a-skill).
27972797
2798<CodeGroup defaultLanguage="CLI">
2798<CodeGroup>
27992799 ```bash cURL
28002800 # Create a new version
28012801 NEW_VERSION=$(curl -X POST "https://api.anthropic.com/v1/skills/skill_01AbCdEfGhIjKlMnOpQrStUv/versions" \
build-with-claude/thinking Changed · +16 / -17 lines
from line 1163
11631163
11641164Each model accepts `max_tokens` up to the ceiling listed here. On the [Message Batches API](https://platform.claude.com/docs/en/build-with-claude/batch-processing#extended-output-beta), the `output-300k-2026-03-24` [beta header](https://platform.claude.com/docs/en/api/beta-headers) raises that ceiling for the models with a batches ceiling listed.
11651165
1166| Model | Max output tokens | Batches beta ceiling |
1167| :---------------- | :---------------- | :------------------- |
1168| Claude Fable 5.1 | 128K | — |
1169| Claude Mythos 5.1 | 128K | — |
1170| Claude Fable 5 | 128K | — |
1171| Claude Mythos 5 | 128K | — |
1172| Claude Opus 5 | 128K | 300K |
1173| Claude Opus 4.8 | 128K | 300K |
1174| Claude Opus 4.7 | 128K | 300K |
1175| Claude Opus 4.6 | 128K | 300K |
1176| Claude Opus 4.5 | 64K | Not available |
1177| Claude Sonnet 5 | 128K | 300K |
1178| Claude Sonnet 4.6 | 128K | 300K |
1179| Claude Sonnet 4.5 | 64K | Not available |
1180| Claude Haiku 4.5 | 64K | Not available |
1181
1182[Claude Mythos Preview](https://anthropic.com/glasswing) accepts `max_tokens` up to 128K; the Batches beta ceiling is not available for it.
1166| Model | Max output tokens | Batches beta ceiling |
1167| :-------------------- | :---------------- | :------------------- |
1168| Claude Fable 5.1 | 128K | — |
1169| Claude Mythos 5.1 | 128K | — |
1170| Claude Fable 5 | 128K | — |
1171| Claude Mythos 5 | 128K | — |
1172| Claude Mythos Preview | 128K | Not available |
1173| Claude Opus 5 | 128K | 300K |
1174| Claude Opus 4.8 | 128K | 300K |
1175| Claude Opus 4.7 | 128K | 300K |
1176| Claude Opus 4.6 | 128K | 300K |
1177| Claude Opus 4.5 | 64K | Not available |
1178| Claude Sonnet 5 | 128K | 300K |
1179| Claude Sonnet 4.6 | 128K | 300K |
1180| Claude Sonnet 4.5 | 64K | Not available |
1181| Claude Haiku 4.5 | 64K | Not available |
11831182
11841183See the [models overview](https://platform.claude.com/docs/en/models/overview) for limits on legacy models.
11851184