Reference
Commitment portfolio ledger
One row per commitment across every connected account, resolving the account that holds it against the accounts that consume it, with the expiry instant, the utilization trend, and what a renewal protects kept separate from what right-sizing would save.
Authorization
BearerAuth In: header
Query Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/commitments/portfolio"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"basis": "list",
"totals": {
"commitment_count": 0,
"hourly_commitment_usd": 0,
"fee_monthly_list": 0,
"fee_monthly_net": 0,
"protects_monthly": 0,
"rightsizing_monthly": 0,
"expiring_within_30d": 0,
"organization_count": 0
},
"rows": [
{
"id": "string",
"service": "string",
"service_label": "string",
"kind": "reserved_instance",
"holder_account_id": "string",
"holder_account_name": "string",
"consumers": [
{
"account_id": "string",
"account_name": "string",
"covered_spend_monthly": 0,
"covered_hours": 0
}
],
"organization_id": "string",
"region": "string",
"applies_to": "string",
"unit_count": 0,
"unit_rate_hourly": 0,
"hourly_commitment_usd": 0,
"fee_monthly_list": 0,
"fee_monthly_net": 0,
"end_at": "string",
"expires_in_seconds": 0,
"utilization_pct": 0,
"coverage_pct": 0,
"utilization_slope_pp_30d": 0,
"saturated": true,
"protects_monthly": 0,
"rightsizing_monthly": 0,
"exchangeable": true,
"cancellable": true,
"predecessor_id": "string",
"status": "active"
}
]
}
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}Get commitments overview GET
ESR strip and aggregate RI/SP metrics for the requested provider (AWS real, GCP/Azure return zeros).
Where a Savings Plan purchase stands GET
One BUY- purchase: what it buys, the tranche it belongs to, and its latest purchase run with the steps, logs and trigger of its row. execution.status reads as it does for a renewal, plus returned when AWS refunded the plan after it was bought, and cancelled when a plan queued inside AWS was deleted while queued. execution.starts_at is when AWS starts such a plan: only runs sent before LevelFour stopped queueing inside AWS carry either. bought_outside names the plan of the same type and term bought outside LevelFour that stopped the latest run. execution.status reads scheduled while a released purchase waits on LevelFour's side until execution.send_at, and cancelled_before_purchase once it was cancelled before it was sent. execution.can_buy_now and execution.can_cancel say whether the caller may buy it now or cancel it at this moment, by the rules those two routes apply. Reads stored state only and never calls AWS. 404 for an id that is no purchase of this organization.