Get Cost and Usage

post/api/v2/invoices/cost-and-usage

Request

  • Base URL
    https://api.umbrellacost.io
  • URL
    https://api.umbrellacost.io/api/v2/invoices/cost-and-usage
  • Auth
    none declared. Required headers: Authorization, apikey

Headers

Authorizationstring required
apikeystring required

Request body

startDatestring required

Start of the range. Example: 2026-04-16

endDatestring required

Must be on or after startDate. The span may not exceed 36 months. Example: 2026-08-16

periodGranLevelstring required

Granularity. Values: day, week, month, quarter, year

groupBystring

Dimension(s) to group by (Two levels maximum). Example: ["service", "usagedate"]

costTypestring

Charge classification, not a cost metric. One or more of cost, credit, discount, refund, tax

costglobaltypestring

Data source scope. By default, it is cloud+K8s. Specify whether to see only K8s or cloud costs. Example: costglobaltype: "cloud"

conjunctionstring

How the filter families combine - and (default) or or. Example: conjunction: {customtags: "or"}

unitEconomicsobject

The KPI or metric to measure instead of cost. See Unit economics above.

dateBasisstring

GCP only. 'usagedate' (default) or 'invoicemonth'.

carbonEmissionsUsagestring

Measure emissions or water instead of cost. One of 'totalCarbonEmissions', 'usageCarbonEmissions', 'manufacturingCarbonEmissions', 'cloudUsageElectricityConsumption', 'waterElectricity', 'waterCooling', 'waterTotal'. The chosen figure replaces total_cost.

isRateUsageBasedboolean

Keep the quantitytype filter applied to the usage side, for rate-per-unit queries.

isTimezonePSTboolean

For GCP only. Read the hourly table and bucket in PST rather than UTC.

isAmortizedboolean

Return amortized cost.

isNetAmortizedboolean

Return net unblended cost.

isNetUnblendedboolean

Return net unblended cost.

isDistributedboolean

Return distributed (shared-cost-allocated) cost.

isPublicCostboolean

Return public (list) cost.

isWasteCostAllocationboolean

Distribute the node-level unused cost among the pods. Only meaningful with a Kubernetes groupBy

tokenstring

Pagination token, use the nextToken from previous response

Changes

No recorded changes to this operation across all 1 revision of this API.