Forecast
The month-end forecast of the Organization's live usage against its spend cap, with its inputs (1.57.0). The platform fee is a separate line and not included.
An object with 12 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
as_of | string | yes | The instant of the latest rollup the forecast read, RFC 3339. |
currency | "USD" | yes | |
days | array of ForecastDay | yes | One input per remaining day, in order. |
estimate | true | yes | Always true: an estimate from list prices and past usage, not a bill. |
exceeds_cap | boolean or null | yes | True when forecast_micros is above the cap; null without a cap. |
forecast_micros | integer | yes | Month to date plus the mean of every remaining day. |
high_micros | integer | yes | Whole micro-USD. |
low_micros | integer | yes | Whole micro-USD. |
month | string | yes | The current UTC month. |
month_to_date_micros | integer | yes | The month's live usage so far. |
object | "forecast" | yes | |
spend_cap_micros | integer or null | yes | The Organization's spend cap; null when it has none. |
Used by
The operations whose parameters, request body or responses name this shape directly.