overlane billing limits | Overlane Docs

Prints the plan, the seats, the allowance for each meter (reviews, CI minutes, docs calls, tasks, private projects), the retention days, whether overage is billed and whether the workspace is read-only. For what is used so far, see overlane billing usage. Any role may read it.

Usage

overlane billing limits [--service URL] [--team TENANT_ID]

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no		The team (tenant) to act on (default: the one your token belongs to)

Examples

overlane billing limits

Behavior

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

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",
      "minLength": 1
    },
    "plan": {
      "type": "string",
      "enum": [
        "free",
        "pro",
        "team",
        "business",
        "enterprise"
      ]
    },
    "seats": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "allowances": {
      "type": "object",
      "properties": {
        "privateProjects": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "string",
              "const": "unlimited"
            },
            {
              "type": "null"
            }
          ]
        },
        "tasks": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "string",
              "const": "unlimited"
            },
            {
              "type": "null"
            }
          ]
        },
        "reviews": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "string",
              "const": "unlimited"
            },
            {
              "type": "null"
            }
          ]
        },
        "docsCalls": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "string",
              "const": "unlimited"
            },
            {
              "type": "null"
            }
          ]
        },
        "ciMinutes": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "string",
              "const": "unlimited"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "privateProjects",
        "tasks",
        "reviews",
        "docsCalls",
        "ciMinutes"
      ],
      "additionalProperties": false
    },
    "retentionDays": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "readOnly": {
      "type": "boolean"
    },
    "overage": {
      "type": "boolean"
    },
    "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)))$"
    },
    "periodEnd": {
      "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",
    "plan",
    "seats",
    "allowances",
    "retentionDays",
    "readOnly",
    "overage",
    "periodStart",
    "periodEnd"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.