overlane docs usage | Overlane Docs

Shows the plan, the calls used this calendar month (UTC) and how many remain. A call past the allowance is refused with exit code 6.

Usage

overlane docs usage [--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 docs usage
overlane docs usage --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 docs usage.

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,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "plan": {
      "type": "string",
      "enum": [
        "free",
        "pro",
        "team",
        "business",
        "enterprise"
      ]
    },
    "period": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}$"
    },
    "used": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "limit": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "remaining": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "operation": {
      "type": "string",
      "const": "usage"
    }
  },
  "required": [
    "tenantId",
    "plan",
    "period",
    "used",
    "limit",
    "remaining",
    "operation"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.