SpendSummary
The Organization's live spend in the current UTC calendar month from its spend counter, its spend cap and what remains, and the previous month's total (1.23.0). The counter advances in the finalize transaction, within 60 seconds of a Call's end (target); amounts only, never content.
An object with 7 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
object | "spend_summary" | yes | |
period_start | string (date) | yes | The first day of the current UTC calendar month, which the counter covers up to the first day of the next (1.23.0). |
previous_period_spend_micros | integer | yes | The counter of the previous UTC calendar month as it closed, in whole micro-USD (1.23.0); 0 when that month counted nothing. It is the month's spend, not a statement or an invoice. |
remaining_micros | integer or null | yes | The cap less the spend, never below 0; null when there is no cap (1.23.0). At 0 admission refuses new Calls with spend_cap_reached, while Calls in progress continue and are counted at their finalize. |
spend_cap_micros | SpendCapMicros or null | yes | The monthly spend cap the counter is compared with; null when the Organization has none (1.23.0). |
spend_micros | integer | yes | The Organization's spend counter for the current month in whole micro-USD (1.23.0): the rated amounts of the live Usage events written this month, read from the counter as admission reads it; 0 before the month's first finalized live Call. |
updated_at | Timestamp or null | yes | When a finalize last advanced the counter of the current month; null before the month's first finalized live Call (1.23.0). |
Used by
The operations whose parameters, request body or responses name this shape directly.