overlane budget show | Overlane Docs

Show budgets per task, agent, project and team, with what is spent and what is left

Lists every limit with the spend counted against it this billing period (a task’s budget counts its whole life). Spending caps set with overlane billing caps appear here too, read through the same check.

Usage

overlane budget show

Examples

overlane budget show
overlane budget show --json

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema budget show.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "limits": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "scope": {
            "type": "string",
            "enum": [
              "task",
              "agent",
              "project",
              "team"
            ]
          },
          "scopeId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "limitCents": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 100000000
          },
          "updatedBy": {
            "type": "string",
            "minLength": 1
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          }
        },
        "required": [
          "tenantId",
          "scope",
          "scopeId",
          "limitCents",
          "updatedBy",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    },
    "summary": {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
          "description": "tenant identifier"
        },
        "periodStart": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "lines": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "scope": {
                "type": "string",
                "enum": [
                  "task",
                  "agent",
                  "project",
                  "team"
                ]
              },
              "scopeId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "source": {
                "type": "string",
                "enum": [
                  "budget",
                  "billing_cap"
                ]
              },
              "limitCents": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "spentCents": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "remainingCents": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "scope",
              "scopeId",
              "source",
              "limitCents",
              "spentCents",
              "remainingCents"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "tenantId",
        "periodStart",
        "lines"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "tenantId",
    "limits",
    "summary"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.