Claude Platform Docs

Daftar Batas Pengeluaran Efektif

GET/v1/organizations/spend_limits/effective

Menampilkan daftar batas pengeluaran efektif setiap anggota dan pengeluaran periode berjalan.

Mengembalikan satu baris per (anggota, periode) yang batas pengeluarannya berlaku bagi anggota tersebut, dengan cakupan source tempat batas pengeluaran itu diwarisi. Paginasi dilakukan per anggota, sehingga periode seorang anggota tidak pernah terpecah antarhalaman.

Query parameters
limit: optional number

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

default20
maximum1000
minimum1
page: optional string

Opaque cursor from a previous response's next_page field.

period: optional array of "daily" or "monthly" or "weekly"

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

maxItems3
One of the following:
"daily"
"monthly"
"weekly"
user_ids: optional array of string

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

maxItems100
Returns
data: array of SpendSummary { actor, amount, currency, 5 more }
actor: object{ deleted, email_address, name, 2 more }

A user within the organization. name and email_address are null when the underlying account is unavailable or has been deleted; deleted is true only for deleted accounts.

deleted: boolean

True only when the underlying account has been deleted.

defaultfalse
email_address: string or null

The user's email address. Null when the account is unavailable or has been deleted.

name: string or null

The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.

type: "user_actor"

Actor type. Always user_actor.

defaultuser_actor
user_id: string

Tagged ID of the user.

amount: string or null

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

currency: string

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

period: "daily" or "monthly" or "weekly"

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

One of the following:
"daily"
"monthly"
"weekly"
period_to_date_spend: string

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

scope: object{ type, user_id }

Scope selecting a single member of the organization.

type: "user"

Scope type. Always user for this scope.

defaultuser
user_id: string

Tagged ID of the member the spend limit applies to.

source: object{ type, user_id } or object{ seat_tier, type } or object{ rbac_group_id, type } or 2 more

Scope selecting a single member of the organization.

One of the following:
User object{ type, user_id }

Scope selecting a single member of the organization.

type: "user"

Scope type. Always user for this scope.

defaultuser
user_id: string

Tagged ID of the member the spend limit applies to.

SeatTier object{ seat_tier, type }
seat_tier: string
type: "seat_tier"
defaultseat_tier
RbacGroup object{ rbac_group_id, type }
rbac_group_id: string
type: "rbac_group"
defaultrbac_group
OrganizationService object{ service, type }
service: string
type: "organization_service"
defaultorganization_service
Organization object{ type }
type: "organization"
defaultorganization
spend_limit_id: string
next_page: string or null
Daftar Batas Pengeluaran Efektif
cURL
curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_AUTH_TOKEN"
Returns Examples
Response 200
{
  "data": [
    {
      "actor": {
        "deleted": true,
        "email_address": "email_address",
        "name": "name",
        "type": "user_actor",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "amount": "50000",
      "currency": "USD",
      "period": "monthly",
      "period_to_date_spend": "12050.5",
      "scope": {
        "type": "user",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "source": {
        "type": "user",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "spend_limit_id": "spend_limit_id"
    }
  ],
  "next_page": "next_page"
}