SPB Git

Repository Public

increase_requests.md 52.6 KB


# title: Increase Requests url: https://platform.claude.com/docs/en/api/beta/organization/spend_limits/increase_requests

# Increase Requests

# List Spend Limit Increase Requests

GET /v1/organizations/spend_limit_increase_requests

List spend limit increase requests, most recent first.

Pending requests include a live spend_summary for the requester. Requests whose requester is no longer a member are excluded.

# Query parameters

  • actor_ids: optional array of string

    Filter by requester, as user_... tagged IDs.

  • limit: optional number

    default: 20, maximum: 1000, minimum: 1

  • page: optional string

    Opaque cursor from a previous response's next_page.

  • status: optional array of "approved" or "denied" or "pending"

    Filter by status. Omit to return all.

    • "approved"

    • "denied"

    • "pending"

# Returns

  • data: array of BetaSpendLimitIncreaseRequest

    • type: "spend_limit_increase_request"

      default: spend_limit_increase_request

    • id: string

    • actor: 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.

    • created_at: string

      format: date-time

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

      • "daily"

      • "monthly"

      • "weekly"

    • resolved_at: string or null

      format: date-time

    • resolved_by: UserActor or ScopedAPIKeyActor or null

      • 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

    • spend_summary: BetaSpendSummary or null

      Per-member effective-limit report row (GET /spend_limits/effective).

      • 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

    • status: "approved" or "denied" or "pending"

      • "approved"

      • "denied"

      • "pending"

  • next_page: string or null

# Example

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

# Response (200)

json
{
  "data": [
    {
      "id": "id",
      "actor": {
        "deleted": true,
        "email_address": "email_address",
        "name": "name",
        "type": "user_actor",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "period": "monthly",
      "resolved_at": "2019-12-27T18:11:19.117Z",
      "resolved_by": {
        "deleted": true,
        "email_address": "email_address",
        "name": "name",
        "type": "user_actor",
        "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
      },
      "spend_summary": {
        "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"
      },
      "status": "approved",
      "type": "spend_limit_increase_request"
    }
  ],
  "next_page": "next_page"
}

# Get Spend Limit Increase Request

GET /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Retrieve a spend limit increase request.

While pending, the response includes a live spend_summary for the requester at the request's period.

# Path parameters

  • spend_limit_increase_request_id: string

    ID of the spend limit increase request.

# Returns

  • BetaSpendLimitIncreaseRequest object

    • type: "spend_limit_increase_request"

      default: spend_limit_increase_request

    • id: string

    • actor: 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.

    • created_at: string

      format: date-time

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

      • "daily"

      • "monthly"

      • "weekly"

    • resolved_at: string or null

      format: date-time

    • resolved_by: UserActor or ScopedAPIKeyActor or null

      • 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

    • spend_summary: BetaSpendSummary or null

      Per-member effective-limit report row (GET /spend_limits/effective).

      • 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

    • status: "approved" or "denied" or "pending"

      • "approved"

      • "denied"

      • "pending"

# Example

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

# Response (200)

json
{
  "id": "id",
  "actor": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "period": "monthly",
  "resolved_at": "2019-12-27T18:11:19.117Z",
  "resolved_by": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "spend_summary": {
    "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"
  },
  "status": "approved",
  "type": "spend_limit_increase_request"
}

# Approve Spend Limit Increase Request

POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Approve a pending spend limit increase request.

Writes a per-user spend limit at amount for the requester and transitions the request to approved. period defaults to the period the member was blocked on. Anthropic emails the requester unless suppress_notification is set.

# Path parameters

  • spend_limit_increase_request_id: string

    ID of the spend limit increase request.

# Body parameters

  • amount: string

    New per-user spend limit as a non-negative integer decimal string (minor units).

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

    • "daily"

    • "monthly"

    • "weekly"

  • suppress_notification: optional boolean

# Returns

  • type: "spend_limit_increase_request"

    default: spend_limit_increase_request

  • id: string

  • actor: 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.

  • created_at: string

    format: date-time

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

    • "daily"

    • "monthly"

    • "weekly"

  • resolved_at: string or null

    format: date-time

  • resolved_by: UserActor or ScopedAPIKeyActor or null

    • 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

  • spend_limit: BetaSpendLimit

    A configured spend limit: a cap on metered spend for one scope and period.

    • type: "spend_limit"

      Object type. Always spend_limit.

      default: spend_limit

    • id: string

      Unique tagged ID of the spend limit (spl_...).

    • amount: string or null

      Limit amount as a non-negative integer decimal string in the minor unit of currency (cents for USD): "50000" is $500.00. null means no numeric cap is configured at this scope — see the effective report for whether a limit applies.

    • created_at: string

      RFC 3339 datetime at which the spend limit was created.

      format: date-time

    • currency: string

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

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

      Length of the window the limit resets over. amount caps spend within each period.

      • "daily"

      • "monthly"

      • "weekly"

    • scope: User or SeatTier or RBACGroup or 3 more

      What the limit applies to. A tagged union on type; each variant carries the identifier for its scope.

      • 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.

    • updated_at: string

      RFC 3339 datetime at which the spend limit was last modified.

      format: date-time

  • spend_summary: BetaSpendSummary or null

    Per-member effective-limit report row (GET /spend_limits/effective).

    • 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

  • status: "approved" or "denied" or "pending"

    • "approved"

    • "denied"

    • "pending"

# Example

bash
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "amount": "50000",
          "period": "monthly"
        }'

# Response (200)

json
{
  "id": "id",
  "actor": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "period": "monthly",
  "resolved_at": "2019-12-27T18:11:19.117Z",
  "resolved_by": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "spend_limit": {
    "id": "id",
    "amount": "50000",
    "created_at": "2019-12-27T18:11:19.117Z",
    "currency": "USD",
    "period": "monthly",
    "scope": {
      "type": "user",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
    },
    "type": "spend_limit",
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "spend_summary": {
    "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"
  },
  "status": "approved",
  "type": "spend_limit_increase_request"
}

# Deny Spend Limit Increase Request

POST /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Deny a pending spend limit increase request.

Idempotent on denied; denying an already-approved request returns 400. Anthropic emails the requester unless suppress_notification is set.

# Path parameters

  • spend_limit_increase_request_id: string

    ID of the spend limit increase request.

# Body parameters

  • suppress_notification: optional boolean

# Returns

  • BetaSpendLimitIncreaseRequest object

    • type: "spend_limit_increase_request"

      default: spend_limit_increase_request

    • id: string

    • actor: 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.

    • created_at: string

      format: date-time

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

      • "daily"

      • "monthly"

      • "weekly"

    • resolved_at: string or null

      format: date-time

    • resolved_by: UserActor or ScopedAPIKeyActor or null

      • 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

    • spend_summary: BetaSpendSummary or null

      Per-member effective-limit report row (GET /spend_limits/effective).

      • 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

    • status: "approved" or "denied" or "pending"

      • "approved"

      • "denied"

      • "pending"

# Example

bash
curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{}'

# Response (200)

json
{
  "id": "id",
  "actor": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "period": "monthly",
  "resolved_at": "2019-12-27T18:11:19.117Z",
  "resolved_by": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "spend_summary": {
    "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"
  },
  "status": "approved",
  "type": "spend_limit_increase_request"
}

# Domain types

# Beta Spend Limit Increase Request

  • BetaSpendLimitIncreaseRequest object

    • type: "spend_limit_increase_request"

      default: spend_limit_increase_request

    • id: string

    • actor: 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.

    • created_at: string

      format: date-time

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

      • "daily"

      • "monthly"

      • "weekly"

    • resolved_at: string or null

      format: date-time

    • resolved_by: UserActor or ScopedAPIKeyActor or null

      • 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

    • spend_summary: BetaSpendSummary or null

      Per-member effective-limit report row (GET /spend_limits/effective).

      • 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

    • status: "approved" or "denied" or "pending"

      • "approved"

      • "denied"

      • "pending"

# Increase Request Approve Response

  • IncreaseRequestApproveResponse object

    • type: "spend_limit_increase_request"

      default: spend_limit_increase_request

    • id: string

    • actor: 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.

    • created_at: string

      format: date-time

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

      • "daily"

      • "monthly"

      • "weekly"

    • resolved_at: string or null

      format: date-time

    • resolved_by: UserActor or ScopedAPIKeyActor or null

      • 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

    • spend_limit: BetaSpendLimit

      A configured spend limit: a cap on metered spend for one scope and period.

      • type: "spend_limit"

        Object type. Always spend_limit.

        default: spend_limit

      • id: string

        Unique tagged ID of the spend limit (spl_...).

      • amount: string or null

        Limit amount as a non-negative integer decimal string in the minor unit of currency (cents for USD): "50000" is $500.00. null means no numeric cap is configured at this scope — see the effective report for whether a limit applies.

      • created_at: string

        RFC 3339 datetime at which the spend limit was created.

        format: date-time

      • currency: string

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

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

        Length of the window the limit resets over. amount caps spend within each period.

        • "daily"

        • "monthly"

        • "weekly"

      • scope: User or SeatTier or RBACGroup or 3 more

        What the limit applies to. A tagged union on type; each variant carries the identifier for its scope.

        • 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.

      • updated_at: string

        RFC 3339 datetime at which the spend limit was last modified.

        format: date-time

    • spend_summary: BetaSpendSummary or null

      Per-member effective-limit report row (GET /spend_limits/effective).

      • 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

    • status: "approved" or "denied" or "pending"

      • "approved"

      • "denied"

      • "pending"

Files main
Menu

Theme