Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Cloud Cost Management

Get commitments list

Get a list of individual cloud commitments (Reserved Instances or Savings Plans) with their utilization details. The response schema varies based on the provider, product, and commitment type.

get/api/v2/cost/commitments/commitment-list

Query parameters

provider'aws' | 'azure' required

Cloud provider for commitment programs.

Example:aws

Cloud provider for commitment programs (aws or azure).

productstring required

Cloud product identifier (for example, ec2, rds, virtualmachines).

startinteger required

Start of the query time range in Unix milliseconds.

endinteger required

End of the query time range in Unix milliseconds.

filterBystring

Optional filter expression to narrow down results.

commitmentType'ri' | 'sp'

Type of commitment. ri for Reserved Instances, sp for Savings Plans.

Example:ri

Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri.

Response

OK

Example response

{
  "commitments": [
    {
      "commitment_id": "ri-0123456789abcdef0",
      "instance_type": "m5.xlarge",
      "offering_class": "standard",
      "operating_system": "Linux",
      "purchase_option": "All Upfront",
      "region": "us-east-1"
    }
  ],
  "meta": {
    "committed_spend_unit": {
      "family": "percentage",
      "id": 17,
      "name": "percent",
      "plural": "percent",
      "scale_factor": 1,
      "short_name": "%"
    }
  }
}