Skip to content

CostTotals

The totals of the instance’s costs over the periods from the one that holds from to the one that holds to, oldest first.

object
granularity
required

The periods of the totals: ISO 8601 weeks (Monday to Sunday), calendar months, or calendar years, cut by date.

string
Allowed values: week month year
basis
required

How the totals place a payment. amortized (the default) spreads each payment of a schedule longer than a month (every 2 or more months, every year, every 5 or more weeks) by day over the days up to the next payment, with the cumulative rounding; the other payments stay on their dates. cash places every payment on its date. Imported usage charges spread by day over their billing period under both.

string
Allowed values: amortized cash
periods
required
Array<object>

A week, month, or year of the totals (label: 2026-W17, 2026-04, or 2026): the total of each currency, never converted, sorted by currency code, and the breakdown by provider, category, and currency. A currency appears when a cost meets the period, even with a zero amount. estimated reports that an imported usage charge of a billing month that its provider has not closed meets the period: its amount may still change.

object
label
required
string
starts_on
required

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
ends_on
required

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
totals
required
Array<object>

An amount of money: a decimal string in the major unit with the digits of its currency (12.34 USD, 1650 JPY), never a JSON number, and its ISO 4217 code.

object
amount
required
string
/^-?[0-9]+(\.[0-9]+)?$/
currency
required
string
/^[A-Z]{3}$/
breakdown
required
Array<object>

The amount of a provider, category, and currency in a period. The costs group by the provider in NFKC and lower case, so ConoHa, conoha, and ConoHa share a line.

object
provider
required

The provider as entered, one spelling for every line of the same grouped provider in the period: the provider of the cost item whose current label was revised last among the items with payments in the period (the larger revision ID on a tie), or, for a provider of imported costs only, the import’s provider name (AWS, Google Cloud).

string
category
required

The fixed category of a cost; clients translate its name.

string
Allowed values: compute database storage network domain email software other
amount
required

Schema: Money

object
estimated
required
boolean
rules
required
object

Example generated

{
"granularity": "week",
"basis": "amortized",
"periods": [
{
"label": "example",
"starts_on": "example",
"ends_on": "example",
"totals": [
{
"amount": "example",
"currency": "example"
}
],
"breakdown": [
{
"provider": "example",
"category": "compute",
"amount": {}
}
],
"estimated": true
}
],
"rules": {}
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site