Sustema

ENTITY developer reference

UsageBudgetHeadroom

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Current authorised customer scope only. Remaining=max(0,ceiling-settled-reserved), same unit/scale. Counters include all relevant funding classes once. No other workspace/person or global maintenance-pool amount is disclosed.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

scope

Listed in this schema’s required array.

Declared type
"string"
Reading definition for scope
{
  "type": "string",
  "enum": [
    "workspace",
    "principal",
    "sponsoring_person",
    "operation"
  ],
  "x-profile-maxLength": "string_characters_max"
}

window_kind

Listed in this schema’s required array.

Declared type
"string"
Reading definition for window_kind
{
  "type": "string",
  "enum": [
    "period",
    "operation"
  ],
  "x-profile-maxLength": "string_characters_max"
}

window_id

Listed in this schema’s required array.

Declared type
"string"
Reading definition for window_id
{
  "type": "string",
  "minLength": 1,
  "maxLength": 200,
  "x-profile-maxLength": "string_characters_max"
}

window_start

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for window_start
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

window_end

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for window_end
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

ceiling_units

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for ceiling_units
{
  "$ref": "#/components/schemas/Units"
}

settled_units

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for settled_units
{
  "$ref": "#/components/schemas/Units"
}

reserved_units

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for reserved_units
{
  "$ref": "#/components/schemas/Units"
}

remaining_units

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for remaining_units
{
  "$ref": "#/components/schemas/Units"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "workspace",
        "principal",
        "sponsoring_person",
        "operation"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "window_kind": {
      "type": "string",
      "enum": [
        "period",
        "operation"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "window_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "x-profile-maxLength": "string_characters_max"
    },
    "window_start": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "window_end": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "ceiling_units": {
      "$ref": "#/components/schemas/Units"
    },
    "settled_units": {
      "$ref": "#/components/schemas/Units"
    },
    "reserved_units": {
      "$ref": "#/components/schemas/Units"
    },
    "remaining_units": {
      "$ref": "#/components/schemas/Units"
    }
  },
  "required": [
    "scope",
    "window_kind",
    "window_id",
    "window_start",
    "window_end",
    "ceiling_units",
    "settled_units",
    "reserved_units",
    "remaining_units"
  ],
  "additionalProperties": false,
  "description": "Current authorised customer scope only. Remaining=max(0,ceiling-settled-reserved), same unit/scale. Counters include all relevant funding classes once. No other workspace/person or global maintenance-pool amount is disclosed.",
  "allOf": [
    {
      "if": {
        "properties": {
          "window_kind": {
            "const": "operation"
          }
        },
        "required": [
          "window_kind"
        ]
      },
      "then": {
        "properties": {
          "scope": {
            "const": "operation"
          },
          "window_start": {
            "type": "null"
          },
          "window_end": {
            "type": "null"
          },
          "settled_units": {
            "const": "0"
          },
          "reserved_units": {
            "const": "0"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "window_kind": {
            "const": "period"
          }
        },
        "required": [
          "window_kind"
        ]
      },
      "then": {
        "properties": {
          "window_start": {
            "type": "string",
            "format": "date-time",
            "x-profile-maxLength": "string_characters_max"
          },
          "window_end": {
            "type": "string",
            "format": "date-time",
            "x-profile-maxLength": "string_characters_max"
          },
          "scope": {
            "type": "string",
            "enum": [
              "workspace",
              "principal",
              "sponsoring_person"
            ],
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    }
  ]
}

Related schemas

All API operations