The spend limits object

⚠️

Preview — this feature is being built; the design below is the spec.

The spend_limits object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "type": "spend_limits",
  "period": {
    "starting_at": "2026-11-01T00:00:00Z",
    "ending_at": "2026-12-01T00:00:00Z"
  },
  "credits_enabled": true,
  "multi_group_policy": "lower",
  "organization": {
    "monthly_limit_usd": "500.00",
    "spent_usd": "212.4031"
  },
  "workspaces": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "monthly_limit_usd": "400.00",
      "spent_usd": "198.1022"
    }
  ],
  "groups": [
    {
      "group_id": "grp_01JB4D6F8H0K2M4P6R8T",
      "name": "Contractors",
      "monthly_limit_usd": "20.00"
    }
  ],
  "members": [
    {
      "user_id": "user_01J9Y0A2C4E6G8J0L2N4",
      "monthly_limit_usd": null,
      "inherited_limit_usd": "20.00",
      "inherited_from_group_id": "grp_01JB4D6F8H0K2M4P6R8T",
      "effective_limit_usd": "20.00",
      "spent_usd": "6.2200"
    }
  ]
}

Fields

Field	Type	Description
`type`	string	The object type, always `spend_limits`.
`period`	object	The current calendar month in UTC; every limit resets at its end.
`credits_enabled`	boolean	See the endpoint pages below.
`multi_group_policy`	string	`higher` or `lower`: which group limit applies to a member in several limited groups.
`organization`	object	Nested detail; see the endpoint pages below.
`workspaces`	array	Nested detail; see the endpoint pages below.
`groups`	array	Nested detail; see the endpoint pages below.
`members`	array	Nested detail; see the endpoint pages below.

Returned by

spend_limit_request token_count

Was this page helpful?