API reference · schema

CreateBudgetRequest

12 fields · used by 1 operations

Last reviewed 2026-10-02

Fields

Field	Type	Meaning
`name` required	string	min length `1` · max length `255`
`description`	string	default `""`
`scope`	string	default `"tenant"`
`scope_id`	string or null
`parent_id`	string or null
`limit_cents` required	number	> `0.0`
`period`	string	default `"monthly"`
`hard_limit`	boolean	default `true`
`soft_limit_pct`	number	min `0.0` · max `100.0` · default `80.0`
`alert_threshold_pct`	number	min `0.0` · max `100.0` · default `50.0`
`currency`	string	default `"USD"`
`metadata`	object or null

Smallest valid example

{
  "name": "name",
  "description": "",
  "scope": "tenant",
  "limit_cents": 1.0,
  "period": "monthly",
  "hard_limit": true,
  "soft_limit_pct": 80.0,
  "alert_threshold_pct": 50.0,
  "currency": "USD"
}

Used by 1 operation

POST /fabric/budgets Create Budget

JSON Schema

Show the raw definition

{
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "title": "Name"
    },
    "description": {
      "type": "string",
      "title": "Description",
      "default": ""
    },
    "scope": {
      "type": "string",
      "title": "Scope",
      "default": "tenant"
    },
    "scope_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scope Id"
    },
    "parent_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Parent Id"
    },
    "limit_cents": {
      "type": "number",
      "exclusiveMinimum": 0.0,
      "title": "Limit Cents"
    },
    "period": {
      "type": "string",
      "title": "Period",
      "default": "monthly"
    },
    "hard_limit": {
      "type": "boolean",
      "title": "Hard Limit",
      "default": true
    },
    "soft_limit_pct": {
      "type": "number",
      "maximum": 100.0,
      "minimum": 0.0,
      "title": "Soft Limit Pct",
      "default": 80.0
    },
    "alert_threshold_pct": {
      "type": "number",
      "maximum": 100.0,
      "minimum": 0.0,
      "title": "Alert Threshold Pct",
      "default": 50.0
    },
    "currency": {
      "type": "string",
      "title": "Currency",
      "default": "USD"
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Metadata"
    }
  },
  "type": "object",
  "required": [
    "name",
    "limit_cents"
  ],
  "title": "CreateBudgetRequest"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account → · Try the sandbox · See the whole ecosystem