BillingOverviewProject

Fields

16 fields

cap_hits · required

integer

covered_usd

number or null

current_cost_usd · required

number

hard_cap_usd

number or null

included_usd

number or null

overage_charge_usd

number or null

overage_rate_usd

number or null

overage_usd

number or null

project_id · required

string (uuid)

project_name · required

string

projected_overage_charge_usd

number or null

projected_overage_usd

number or null

projected_period_cost_usd

number or null

projection_basis

string or null

status · required

string

utilization_pct

number or null

Raw schema (JSON)

{
  "properties": {
    "cap_hits": {
      "title": "Cap Hits",
      "type": "integer"
    },
    "covered_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Covered Usd"
    },
    "current_cost_usd": {
      "title": "Current Cost Usd",
      "type": "number"
    },
    "hard_cap_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Hard Cap Usd"
    },
    "included_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Included Usd"
    },
    "overage_charge_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Overage Charge Usd"
    },
    "overage_rate_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Overage Rate Usd"
    },
    "overage_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Overage Usd"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "project_name": {
      "title": "Project Name",
      "type": "string"
    },
    "projected_overage_charge_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Projected Overage Charge Usd"
    },
    "projected_overage_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Projected Overage Usd"
    },
    "projected_period_cost_usd": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Projected Period Cost Usd"
    },
    "projection_basis": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Projection Basis"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "utilization_pct": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Utilization Pct"
    }
  },
  "required": [
    "project_id",
    "project_name",
    "current_cost_usd",
    "status",
    "cap_hits"
  ],
  "title": "BillingOverviewProject",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• GET /api/v1/billing/overview — Billing Overview

Used by schemas

• BillingOverviewResponse

More details

• Specification: OpenAPI JSON