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.

GET
/api/v1/commitments/portfolio

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

provider?Provider
basis?Basis

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"
}
Ask the FinOps Agent about your cloud spend