overlane billing usage | Overlane Docs

Show usage this period against each allowance, the spending caps and the pooled allowance left

Lists reviews, CI minutes, docs calls and hosted inference used this period, the allowance each plan gives, units beyond it and what they cost, then the spending caps and, on a plan that pools its allowance, what is left to share and each member’s fair share. Beyond an allowance nothing stops unless a spending cap is set.

Usage

overlane billing usage

Examples

overlane billing usage
overlane billing 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 billing usage.

Result

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

{
  "anyOf": [
    {
      "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"
          ]
        },
        "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)))$"
        },
        "meters": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "meter": {
                "type": "string",
                "enum": [
                  "reviews",
                  "ciMinutes",
                  "docsCalls",
                  "hostedInference"
                ]
              },
              "used": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "allowance": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "string",
                    "const": "unlimited"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "overUnits": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "rateMicros": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "overageMicros": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "meter",
              "used",
              "allowance",
              "overUnits",
              "rateMicros",
              "overageMicros"
            ],
            "additionalProperties": false
          }
        },
        "spendMicros": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "notices": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "caps": {
          "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": [
                  "team",
                  "project",
                  "agent"
                ]
              },
              "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",
              "limitCents",
              "updatedBy",
              "updatedAt"
            ],
            "additionalProperties": false
          }
        },
        "pool": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "seats": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "meters": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "meter": {
                        "type": "string",
                        "enum": [
                          "reviews",
                          "ciMinutes",
                          "docsCalls"
                        ]
                      },
                      "total": {
                        "anyOf": [
                          {
                            "type": "integer",
                            "minimum": 0,
                            "maximum": 9007199254740991
                          },
                          {
                            "type": "string",
                            "const": "unlimited"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      },
                      "used": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      "remaining": {
                        "anyOf": [
                          {
                            "type": "integer",
                            "minimum": 0,
                            "maximum": 9007199254740991
                          },
                          {
                            "type": "null"
                          }
                        ]
                      }
                    },
                    "required": [
                      "meter",
                      "total",
                      "used",
                      "remaining"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "seats",
                "meters"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "discount": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "open_source",
                    "startup"
                  ]
                },
                "percentOff": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 100
                }
              },
              "required": [
                "kind",
                "percentOff"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "tenantId",
        "plan",
        "periodStart",
        "periodEnd",
        "meters",
        "spendMicros",
        "notices",
        "caps",
        "pool",
        "discount"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
          "description": "tenant identifier"
        },
        "projectId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
          "description": "project 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)))$"
        },
        "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)))$"
        },
        "meters": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "meter": {
                "type": "string",
                "enum": [
                  "reviews",
                  "ciMinutes",
                  "docsCalls",
                  "hostedInference"
                ]
              },
              "used": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "meter",
              "used"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "tenantId",
        "projectId",
        "periodStart",
        "periodEnd",
        "meters"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.