Claude Platform Docs

列出有效支出限制

$client->beta->organization->spendLimits->effective->list(?int limit, ?string page, ?list<SpendLimitPeriod> period, ?list<string> userIDs): PageCursor<SpendSummary>
GET/v1/organizations/spend_limits/effective

列出每位成員的有效支出限制及本期至今的支出。

針對成員解析出支出限制的每個（成員, 期間）組合傳回一列，並附上該支出限制所繼承自的 source 範圍。依成員分頁，因此同一成員的各期間絕不會分散在不同頁面。僅支援 Claude Enterprise 組織，不支援 Claude Console 組織。

Parameters
limit?: optional int⁠Query parameter

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

default20
page?: optional string⁠Query parameter

Opaque cursor from a previous response's next_page field.

period?: optional list<SpendLimitPeriod>⁠Query parameter

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

userIDs?: optional list<string>⁠Query parameter

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

Returns
class SpendSummary { $actor; $amount; $currency; /* 5 more */ }
Actor actor
?string amount

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

string currency

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

SpendLimitPeriod period

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

string periodToDateSpend

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

Scope scope
Source source
string spendLimitID
列出有效支出限制
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Anthropic\Client;
use Anthropic\Beta\Organization\SpendLimits\SpendLimitPeriod;

$client = new Client(apiKey: 'my-anthropic-api-key');

$page = $client->beta->organization->spendLimits->effective->list(
  limit: 1, page: 'page', period: [SpendLimitPeriod::DAILY], userIDs: ['string']
);

var_dump($page);
Returns Examples
Response 200
{
  "data": [
    {
      "actor": {
        "deleted": true,
        "email_address": "email_address",
        "name": "name",
        "type": "user_actor",
        "user_id": "user_01WxYzAbCdEfGhJkMnPqRsTu"
      },
      "amount": "50000",
      "currency": "USD",
      "period": "daily",
      "period_to_date_spend": "12050.5",
      "scope": {
        "type": "user",
        "user_id": "user_01WxYzAbCdEfGhJkMnPqRsTu"
      },
      "source": {
        "type": "user",
        "user_id": "user_01WxYzAbCdEfGhJkMnPqRsTu"
      },
      "spend_limit_id": "spend_limit_id"
    }
  ],
  "next_page": "next_page"
}