SPB Git

Repository Public

list_effective.md 6.2 KB


# title: List Effective Spend Limits url: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/list_effective

# List Effective Spend Limits

GET /v1/organizations/spend_limits/effective

List each member's effective spend limit and period-to-date spend.

Returns one row per (member, period) the member resolves a spend limit for, with the source scope the spend limit was inherited from. Paginates by member, so a member's periods never split across pages.

# Query parameters

  • limit: optional number

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

    default: 20, maximum: 1000, minimum: 1

  • page: optional string

    Opaque cursor from a previous response's next_page field.

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

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

    maxItems: 3

    • "daily"

    • "monthly"

    • "weekly"

  • user_ids: optional array of string

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

    maxItems: 100

# Returns

  • data: array of BetaSpendSummary

    • actor: UserActor or ScopedAPIKeyActor

      • UserActor object

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

        • type: "user_actor"

          Actor type. Always user_actor.

          default: user_actor

        • deleted: boolean

          True only when the underlying account has been deleted.

          default: false

        • email_address: string or null

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

        • name: string or null

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

        • user_id: string

          Tagged ID of the user.

      • ScopedAPIKeyActor object

        A scoped Admin API key acting on behalf of the organization.

        • type: "scoped_api_key_actor"

          default: scoped_api_key_actor

        • scoped_api_key_id: string

    • amount: string or null

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

    • currency: string

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

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

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

      • "daily"

      • "monthly"

      • "weekly"

    • period_to_date_spend: string

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

    • scope: User or SeatTier or RBACGroup or 3 more

      • User object

        Scope selecting a single member of the organization.

        • type: "user"

          Scope type. Always user for this scope.

          default: user

        • user_id: string

          Tagged ID of the member the spend limit applies to.

      • SeatTier object

        • type: "seat_tier"

          default: seat_tier

        • seat_tier: string

      • RBACGroup object

        • type: "rbac_group"

          default: rbac_group

        • rbac_group_id: string

      • OrganizationService object

        • type: "organization_service"

          default: organization_service

        • service: string

      • Organization object

        • type: "organization"

          default: organization

      • Workspace object

        Scope selecting one workspace of a Claude Console organization.

        • type: "workspace"

          Scope type. Always workspace for this scope.

          default: workspace

        • workspace_id: string

          Tagged ID of the workspace the spend limit applies to.

    • source: User or SeatTier or RBACGroup or 3 more

      • User object

        Scope selecting a single member of the organization.

        • type: "user"

          Scope type. Always user for this scope.

          default: user

        • user_id: string

          Tagged ID of the member the spend limit applies to.

      • SeatTier object

        • type: "seat_tier"

          default: seat_tier

        • seat_tier: string

      • RBACGroup object

        • type: "rbac_group"

          default: rbac_group

        • rbac_group_id: string

      • OrganizationService object

        • type: "organization_service"

          default: organization_service

        • service: string

      • Organization object

        • type: "organization"

          default: organization

      • Workspace object

        Scope selecting one workspace of a Claude Console organization.

        • type: "workspace"

          Scope type. Always workspace for this scope.

          default: workspace

        • workspace_id: string

          Tagged ID of the workspace the spend limit applies to.

    • spend_limit_id: string

  • next_page: string or null

# Example

bash
curl https://api.anthropic.com/v1/organizations/spend_limits/effective \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "data": [
    {
      "actor": {
        "deleted": true,
        "email_address": "email_address",
        "name": "name",
        "type": "user_actor",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "amount": "50000",
      "currency": "USD",
      "period": "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"
}
Files main
Menu

Theme