BudgetResponse
A budget plus its computed current-period figures. Periods are UTC calendar-aligned (``day`` / ISO ``week`` from Monday / ``month``) or the budget's own ``custom`` window; ``surfaces``/``lens`` ``None`` = all. ``spent_usd`` is ``None`` while a custom window is still upcoming; ``crossed`` is set once the current period has alerted.
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| enabled | boolean | |
| scope | string | |
| project_id | object | |
| project_name | object | |
| period | string | |
| custom_from | object | |
| custom_to | object | |
| surfaces | object | |
| lens | object | |
| usd_threshold | number | |
| period_start | string | |
| period_end | string | |
| state | string | |
| spent_usd | object | |
| crossed | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-budget-response-schema.json",
"title": "BudgetResponse",
"description": "A budget plus its computed current-period figures. Periods are UTC calendar-aligned\n(``day`` / ISO ``week`` from Monday / ``month``) or the budget's own ``custom`` window;\n``surfaces``/``lens`` ``None`` = all. ``spent_usd`` is ``None`` while a custom window is\nstill upcoming; ``crossed`` is set once the current period has alerted.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/onclarity-com-agent-costs-api-openapi.yml#/components/schemas/BudgetResponse",
"properties": {
"id": {
"type": "integer",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"scope": {
"type": "string",
"title": "Scope"
},
"project_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Project Id"
},
"project_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Name"
},
"period": {
"type": "string",
"title": "Period"
},
"custom_from": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Custom From"
},
"custom_to": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Custom To"
},
"surfaces": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Surfaces"
},
"lens": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Lens"
},
"usd_threshold": {
"type": "number",
"title": "Usd Threshold"
},
"period_start": {
"type": "string",
"format": "date-time",
"title": "Period Start"
},
"period_end": {
"type": "string",
"format": "date-time",
"title": "Period End"
},
"state": {
"type": "string",
"title": "State"
},
"spent_usd": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Spent Usd"
},
"crossed": {
"anyOf": [
{
"$ref": "#/$defs/BudgetCrossingResponse"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"name",
"enabled",
"scope",
"project_id",
"period",
"usd_threshold",
"period_start",
"period_end",
"state"
],
"$defs": {
"BudgetCrossingResponse": {
"properties": {
"notified_at": {
"type": "string",
"format": "date-time",
"title": "Notified At"
},
"notified_usd": {
"type": "number",
"title": "Notified Usd"
},
"threshold_at_notify": {
"type": "number",
"title": "Threshold At Notify"
}
},
"type": "object",
"required": [
"notified_at",
"notified_usd",
"threshold_at_notify"
],
"title": "BudgetCrossingResponse",
"description": "The persisted crossing for the budget's CURRENT period (absent = not crossed)."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/onclarity-com-budget-response"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.