> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/api-reference/cost-management-agent-apis/commitment-orchestrator/ri-inventory-overview.md).

# RI Inventory Overview

## Get Reserved Instance Inventory Overview

> Fetches overview of Reserved Instance inventory including total counts, distribution, status, and pending actions

```json
{"openapi":"3.0.1","info":{"title":"Commitment Orchestrator APIs","version":"1.0.0"},"tags":[],"servers":[{"url":"https://app.harness.io/gateway","description":"Production server"}],"paths":{"/accounts/{account_id}/v2/inventory/ri/overview":{"post":{"tags":["RI Inventory Overview"],"summary":"Get Reserved Instance Inventory Overview","description":"Fetches overview of Reserved Instance inventory including total counts, distribution, status, and pending actions","operationId":"GetRIInventoryOverview","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string"},"description":"Account Identifier for the Entity"},{"name":"routingId","in":"query","required":true,"schema":{"type":"string"},"description":"Routing identifier for request processing"},{"name":"start_date","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Start date for the inventory period"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"End date for the inventory period"}],"requestBody":{"description":"Optional filters for the RI inventory","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryRIAPIFilter"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RIInventoryOverviewResponse"}}}},"400":{"description":"Invalid request parameters"}}}}},"components":{"schemas":{"InventoryRIAPIFilter":{"type":"object","properties":{"account_ids":{"type":"array","items":{"type":"string"},"description":"List of provider account IDs"},"cloud_account_ids":{"type":"array","items":{"type":"string"},"description":"List of cloud account IDs"},"instance_types":{"type":"array","items":{"type":"string"},"description":"List of instance types"},"instance_families":{"type":"array","items":{"type":"string"},"description":"List of instance families"},"platforms":{"type":"array","items":{"type":"string"},"description":"List of platforms"},"tenancy":{"type":"array","items":{"type":"string"},"description":"List of tenancy options"},"payment_options":{"type":"array","items":{"type":"string","enum":["No Upfront","Partial Upfront","All Upfront"]},"description":"List of payment options"},"terms":{"type":"array","items":{"type":"number","format":"float64"},"description":"List of term lengths in years"},"plan_types":{"type":"array","items":{"type":"string","enum":["Standard","Convertible"]},"description":"List of RI types"},"status":{"type":"array","items":{"type":"string","enum":["active","expired","pending","retired"]},"description":"List of statuses"},"is_harness_managed":{"type":"boolean","nullable":true,"description":"Filter by Harness managed status"},"regions":{"type":"array","items":{"type":"string"},"description":"List of regions"},"service":{"type":"string","enum":["Amazon Relational Database Service","Amazon Elastic Compute Cloud - Compute","VirtualMachines"],"default":"Amazon Elastic Compute Cloud - Compute","description":"Service to fetch the inventory for. VirtualMachines returns Azure reservations, whose scope is the applied scope (Billing, Subscription or Management Group) instead of the region."}}},"RIInventoryOverviewResponse":{"type":"object","properties":{"ts":{"type":"integer","description":"Response timestamp"},"success":{"type":"boolean","description":"Indicates if the request was successful"},"errors":{"type":"string","nullable":true,"description":"Error details, if any"},"response":{"$ref":"#/components/schemas/RIInventoryOverview"}}},"RIInventoryOverview":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/TotalCount"},"distribution":{"allOf":[{"$ref":"#/components/schemas/RIDistribution"}],"nullable":true,"description":"Standard/Convertible split. Null for VirtualMachines, since Azure reservations have no such split."},"status":{"$ref":"#/components/schemas/StatusBreakdown"},"actions":{"$ref":"#/components/schemas/ActionsBreakdown"}}},"TotalCount":{"type":"object","properties":{"purchased":{"type":"integer","description":"Total number of purchased RIs"},"managed":{"type":"integer","description":"Total number of managed RIs"}}},"RIDistribution":{"type":"object","properties":{"reserved":{"$ref":"#/components/schemas/InstanceTypeDistribution"},"managed":{"$ref":"#/components/schemas/InstanceTypeDistribution"}}},"InstanceTypeDistribution":{"type":"object","properties":{"standard":{"$ref":"#/components/schemas/TypeCount"},"convertible":{"$ref":"#/components/schemas/TypeCount"}}},"TypeCount":{"type":"object","properties":{"count":{"type":"integer","description":"Number of instances of this type"},"percentage":{"type":"number","format":"float","description":"Percentage of total instances"}}},"StatusBreakdown":{"type":"object","properties":{"expired":{"$ref":"#/components/schemas/StatusCount"},"expiring_soon":{"$ref":"#/components/schemas/StatusCount"},"active":{"$ref":"#/components/schemas/StatusCount"}}},"StatusCount":{"type":"object","properties":{"count":{"type":"integer","description":"Count of items in this status"},"label":{"type":"string","description":"Display label for the status"}}},"ActionsBreakdown":{"type":"object","properties":{"pending_approval":{"$ref":"#/components/schemas/StatusCount"}}}}}}
```
