SpendSummary
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
scope * |
ResourceRef | |
headline |
string | |
period * |
object | |
month_to_date * |
Money | |
forecast_month_end * |
Money | |
plan_fee |
Money | |
included_usage |
Money | |
credit_balance |
Money | |
caps |
array of SpendCapStatus | |
by_resource |
array of object | |
breakdown |
array of SpendBreakdownItem | Per project (workspace scope) or per service/database/volume (project scope). |
daily |
array of object | |
updated_at * |
string (date-time) |
* always present
Example
Section titled “Example”{ "scope": { "type": "project", "id": "prj_01jbx2m9k7q4r8t5v6w3y0z1pr", "name": "primecarers" }, "headline": "This month: £7.42 of your £10 cap. Forecast £9.10.", "period": { "start": "2026-10-01T00:00:00Z", "end": "2026-11-01T00:00:00Z" }, "month_to_date": { "amount": "7.42", "currency": "GBP", "display": "£7.42" }, "forecast_month_end": { "amount": "9.10", "currency": "GBP", "display": "£9.10" }, "caps": [ { "cap_id": "cap_01jbx2m9k7q4r8t5v6w3y0z1cp", "scope": "project", "amount": { "amount": "10.00", "currency": "GBP", "display": "£10.00" }, "used_percent": 74.2, "forecast_percent": 91, "state": "warning", "on_cap": "sleep_non_production" } ], "by_resource": [ { "metric": "vcpu_seconds", "quantity": "0.31", "unit": "vCPU-month", "cost": { "amount": "3.10", "currency": "GBP", "display": "£3.10" } }, { "metric": "memory_gb_seconds", "quantity": "0.86", "unit": "GB-month", "cost": { "amount": "4.32", "currency": "GBP", "display": "£4.32" } } ], "breakdown": [ { "type": "service", "id": "svc_01jbx2m9k7q4r8t5v6w3y0z1sv", "name": "web", "environment": "production", "cost": { "amount": "5.10", "currency": "GBP", "display": "£5.10" }, "share_percent": 68.7, "why": "web used 0.2 vCPU and 610 MB on average" } ], "updated_at": "2026-10-23T14:05:00Z"}