read_plan_quotas #

View this page as Markdown

On this page

Generated automatically from the published contract sources.

A script calls this action over HTTPS at POST https://tzcloud.turnzero.ai/v1/read_plan_quotas, with a bearer credential and the action's payload as the JSON body. It also accepts GET. An MCP connection lists this action as the tool tzcloud_read_plan_quotas.

OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts (Sign-in, sessions, and tokens).

Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.

Contract description #

Read size quotas without an application. Pass a size's name as plan for its rows. Omit plan and measure for the sizes' rows. Pass measure for an entry's row on each size that sets it. Pass both for at most one row.

Either size allows development, which you turn on with create_environment.

More about this action #

The answer has the selected sizes' enforced entries and served values. It returns the sizes' rows where you pass neither plan nor measure. Each row has its quantity, null for an Unset cell, and its unit. With stamps: true, it also gives its stamp and author. Any signed-in credential can read the rows, a token bounded to an application included.

Where your credential has the super_admin grant or your account is unbilled, no per-account application limit applies to you. The answer then has application_limit_exemption, set to super_admin or unbilled. It is absent otherwise. With that exemption, create_application does not refuse account_application_limit.

Each quantity is in its entry's base unit, given by unit. Entries retired for the sizes have no row in this read.

A platform setting that is the same on every size has no row here. The schedule window is one: read_schedules and submit_manifest return it as window_seconds. Log retention is another: log-retained-capacity bounds the bytes kept until entries expire.

Pass stamps: true to get when and by whom each row was last set. A size's development- rows give its development environment's bounds.

Left out or false, the stamps argument gives rows with neither stamp, and each row's unit gives its unit.

Access and action metadata #

{
  "name": "read_plan_quotas",
  "resource": "account",
  "tier": "observe",
  "surface": "tzcloud",
  "addresses": [
    "tzcloud"
  ],
  "product": "cloud",
  "clients": [
    "bearer",
    "browser_session"
  ],
  "summary": "Return the served quantities of the selected sizes, or the sizes' rows where neither `plan` nor `measure` is passed. For each size the rows are the enforced entries, then its served values. Each row gives its unit, and with `stamps: true` its stamp and author. Any signed-in credential can read them, an application-bounded token included. No application at that size is needed.\n\nWhere the credential and account bypass the application limit, `application_limit_exemption` gives the exemption.",
  "annotations": {
    "readOnlyHint": true,
    "destructiveHint": false,
    "openWorldHint": false,
    "idempotentHint": true
  }
}

MCP catalog entry #

{
  "name": "read_plan_quotas",
  "title": "Read size quotas",
  "tier": "observe",
  "scenario": "CHI-L0-09",
  "summary": "Read size quotas without an application. Pass a size's name as `plan` for its rows. Omit `plan` and `measure` for the sizes' rows. Pass `measure` for an entry's row on each size that sets it. Pass both for at most one row.\n\nEither size allows development, which you turn on with `create_environment`.",
  "owners": [
    "PRC-L0-16",
    "API-L0-17",
    "ACB-L0-84"
  ]
}

request #

JSON pointer Description and constraints
"" (root) Type: object
Additional properties: false
/properties/plan That size's rows alone, or with measure at most one row. Over the HTTP route an unlisted value is refused invalid_request.

Type: string
Allowed values: ["shared-0.5gb","shared-1gb"]
/properties/measure That entry's row on each size that sets it. With plan, at most a row is returned, and none where that size sets no such value. The detail then says so. Over the HTTP route an unlisted value is refused invalid_request.

Type: string
Allowed values: ["stored-data-capacity","database-connection-limit","schedule-minimum-interval","schedule-count-limit","deploys-per-day","log-retained-capacity","free-idle-stop","development-halt-after-days","development-realm-account-limit","signin-code-sends-per-hour","egress-connections-per-minute","egress-bytes-per-day","websocket-connections-per-replica","push-messages-capacity","email-recipients-per-hour","email-recipients-per-day"]
/properties/stamps true adds each row's set_at and set_by, when and by whom it was last set, and the whole unit list in detail; over the HTTP route a value that is not a boolean is refused invalid_request.

Type: boolean

response #

JSON pointer Description and constraints
"" (root) The selected sizes' quota rows, or the sizes' rows where neither plan nor measure was passed. For each size they give its enforced entries, then its served values.

Each row gives its quantity, null for an Unset cell, and its unit. With stamps: true, it also gives the stamp and author. Where the credential and account bypass the application limit, application_limit_exemption gives the exemption. Entries retired for the sizes are not returned.

Type: object
Required fields: ["contract_version","quotas"]
Additional properties: false
/properties/contract_version Required value: 1
/properties/quotas Type: array
/properties/quotas/items Type: object
Required fields: ["plan","measure","quantity","unit"]
/properties/quotas/items/properties/plan Type: string
Allowed values: ["shared-0.5gb","shared-1gb"]
/properties/quotas/items/properties/measure Type: string
Allowed values: ["stored-data-capacity","database-connection-limit","schedule-minimum-interval","schedule-count-limit","deploys-per-day","log-retained-capacity","free-idle-stop","development-halt-after-days","development-realm-account-limit","signin-code-sends-per-hour","egress-connections-per-minute","egress-bytes-per-day","websocket-connections-per-replica","push-messages-capacity","email-recipients-per-hour","email-recipients-per-day"]
/properties/quotas/items/properties/quantity The quantity in its entry's base unit, null for an Unset cell. The units are schedule-minimum-interval in minutes, free-idle-stop in seconds, free-socket-hours-per-month in seconds, development-halt-after-days in days, development-warm-hours in hours, stored-data-capacity in bytes, data-transfer-capacity in bytes, log-retained-capacity in bytes, egress-bytes-per-day in bytes, gemini-allowance in micro-dollars, 1,000,000 to the dollar. The two -supported entries are 1 or 0, and every other entry a count. The row's unit gives it.

Type: ["integer","null"]
/properties/quotas/items/properties/unit The unit quantity is counted in: minutes, seconds, days, bytes, or micro-dollars, 1 or 0 for the two -supported entries, and count for every other entry.

Type: string
Allowed values: ["count","minutes","seconds","days","hours","bytes","micro-dollars","1 or 0"]
/properties/quotas/items/properties/set_at Under stamps: true alone: when the row was last set.

Type: string
/properties/quotas/items/properties/set_by Under stamps: true alone: seed for a row a migration wrote, otherwise the setting operator's account identifier.

Type: string
/properties/application_limit_exemption Present only where this call's credential and account bypass the per-account application limit: super_admin under the super-admin grant, unbilled for an account carrying the mark. create_application then does not refuse account_application_limit for it.

Type: string
Allowed values: ["super_admin","unbilled"]
/properties/detail What the rows are; under stamps: true, each quantity's base unit too, schedule-minimum-interval in minutes among them.

Type: string

Complete payload contract #

{
  "request": {
    "type": "object",
    "properties": {
      "plan": {
        "type": "string",
        "enum": [
          "shared-0.5gb",
          "shared-1gb"
        ],
        "description": "That size's rows alone, or with `measure` at most one row. Over the HTTP route an unlisted value is refused `invalid_request`."
      },
      "measure": {
        "type": "string",
        "enum": [
          "stored-data-capacity",
          "database-connection-limit",
          "schedule-minimum-interval",
          "schedule-count-limit",
          "deploys-per-day",
          "log-retained-capacity",
          "free-idle-stop",
          "development-halt-after-days",
          "development-realm-account-limit",
          "signin-code-sends-per-hour",
          "egress-connections-per-minute",
          "egress-bytes-per-day",
          "websocket-connections-per-replica",
          "push-messages-capacity",
          "email-recipients-per-hour",
          "email-recipients-per-day"
        ],
        "description": "That entry's row on each size that sets it. With `plan`, at most a row is returned, and none where that size sets no such value. The `detail` then says so. Over the HTTP route an unlisted value is refused `invalid_request`."
      },
      "stamps": {
        "type": "boolean",
        "description": "`true` adds each row's `set_at` and `set_by`, when and by whom it was last set, and the whole unit list in `detail`; over the HTTP route a value that is not a boolean is refused `invalid_request`."
      }
    },
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "quotas"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "quotas": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "plan",
            "measure",
            "quantity",
            "unit"
          ],
          "properties": {
            "plan": {
              "type": "string",
              "enum": [
                "shared-0.5gb",
                "shared-1gb"
              ]
            },
            "measure": {
              "type": "string",
              "enum": [
                "stored-data-capacity",
                "database-connection-limit",
                "schedule-minimum-interval",
                "schedule-count-limit",
                "deploys-per-day",
                "log-retained-capacity",
                "free-idle-stop",
                "development-halt-after-days",
                "development-realm-account-limit",
                "signin-code-sends-per-hour",
                "egress-connections-per-minute",
                "egress-bytes-per-day",
                "websocket-connections-per-replica",
                "push-messages-capacity",
                "email-recipients-per-hour",
                "email-recipients-per-day"
              ]
            },
            "quantity": {
              "type": [
                "integer",
                "null"
              ],
              "description": "The quantity in its entry's base unit, null for an Unset cell. The units are `schedule-minimum-interval` in minutes, `free-idle-stop` in seconds, `free-socket-hours-per-month` in seconds, `development-halt-after-days` in days, `development-warm-hours` in hours, `stored-data-capacity` in bytes, `data-transfer-capacity` in bytes, `log-retained-capacity` in bytes, `egress-bytes-per-day` in bytes, `gemini-allowance` in micro-dollars, 1,000,000 to the dollar. The two `-supported` entries are 1 or 0, and every other entry a count. The row's `unit` gives it."
            },
            "unit": {
              "type": "string",
              "enum": [
                "count",
                "minutes",
                "seconds",
                "days",
                "hours",
                "bytes",
                "micro-dollars",
                "1 or 0"
              ],
              "description": "The unit `quantity` is counted in: `minutes`, `seconds`, `days`, `bytes`, or `micro-dollars`, `1 or 0` for the two `-supported` entries, and `count` for every other entry (PRC-L0-16)."
            },
            "set_at": {
              "type": "string",
              "description": "Under `stamps: true` alone: when the row was last set."
            },
            "set_by": {
              "type": "string",
              "description": "Under `stamps: true` alone: `seed` for a row a migration wrote, otherwise the setting operator's account identifier."
            }
          }
        }
      },
      "application_limit_exemption": {
        "type": "string",
        "enum": [
          "super_admin",
          "unbilled"
        ],
        "description": "Present only where this call's credential and account bypass the per-account application limit: `super_admin` under the super-admin grant, `unbilled` for an account carrying the mark. `create_application` then does not refuse `account_application_limit` for it (ACB-L0-84)."
      },
      "detail": {
        "type": "string",
        "description": "What the rows are; under `stamps: true`, each quantity's base unit too, `schedule-minimum-interval` in minutes among them."
      }
    },
    "additionalProperties": false,
    "description": "The selected sizes' quota rows, or the sizes' rows where neither `plan` nor `measure` was passed. For each size they give its enforced entries, then its served values.\n\nEach row gives its quantity, null for an Unset cell, and its unit. With `stamps: true`, it also gives the stamp and author (PRC-L0-16). Where the credential and account bypass the application limit, `application_limit_exemption` gives the exemption (ACB-L0-84). Entries retired for the sizes are not returned."
  }
}

Shared contracts #