--- title: Get commitments list description: Get a list of individual cloud commitments (Reserved Instances or Savings Plans) with their utilization details. breadcrumbs: Docs > API > Get commitments list --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get commitments list ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/cost/commitments/commitment-list | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/cost/commitments/commitment-list | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/cost/commitments/commitment-list | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/cost/commitments/commitment-list | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/cost/commitments/commitment-list | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/cost/commitments/commitment-list | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/cost/commitments/commitment-list | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/cost/commitments/commitment-list | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/cost/commitments/commitment-list | ### Overview 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. This endpoint requires the `cloud_cost_management_read` permission. OAuth apps require the `cloud_cost_management_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/scopes.md#cloud-cost-management) to access this endpoint. ### Arguments #### Query Strings | Field | Type | Description | | --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | provider [*required*] | enum | Cloud provider for commitment programs (aws or azure). Allowed enum values: `aws`, `azure`. | | product [*required*] | string | Cloud product identifier (for example, ec2, rds, virtualmachines). | | start [*required*] | integer | Start of the query time range in Unix milliseconds. | | end [*required*] | integer | End of the query time range in Unix milliseconds. | | filterBy | string | Optional filter expression to narrow down results. | | commitmentType | enum | Type of commitment to query. ri for Reserved Instances, sp for Savings Plans. Defaults to ri. Allowed enum values: `ri`, `sp`. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response containing a list of cloud commitment details. | Parent field | Field | Type | Description | | -------------------- | ------------------------------- | --------- | ------------------------------------------------------------------------------------------------ | | | commitments [*required*] | [] | Array of commitment items. | | commitments | Object 1 | object | AWS EC2 Reserved Instance commitment details. | | Object 1 | availability_zone | string | The availability zone of the reservation. | | Object 1 | commitment_id [*required*] | string | The unique identifier of the Reserved Instance. | | Object 1 | expiration_date | string | The expiration date of the commitment. | | Object 1 | instance_type [*required*] | string | The EC2 instance type. | | Object 1 | number_of_nfus | double | The number of Normalized Capacity Units. | | Object 1 | number_of_reservations | double | The number of reserved instances. | | Object 1 | offering_class [*required*] | string | The offering class of the Reserved Instance. | | Object 1 | operating_system [*required*] | string | The operating system of the Reserved Instance. | | Object 1 | purchase_option [*required*] | string | The payment option for the Reserved Instance. | | Object 1 | region [*required*] | string | The AWS region of the Reserved Instance. | | Object 1 | start_date | string | The start date of the commitment. | | Object 1 | term_length | double | The term length in years. | | Object 1 | utilization | double | The utilization percentage of the commitment. | | commitments | Object 2 | object | AWS RDS Reserved Instance commitment details. | | Object 2 | commitment_id [*required*] | string | The unique identifier of the Reserved Instance. | | Object 2 | database_engine [*required*] | string | The database engine of the Reserved Instance. | | Object 2 | expiration_date | string | The expiration date of the commitment. | | Object 2 | instance_type [*required*] | string | The RDS instance type. | | Object 2 | is_multi_az | boolean | Whether the Reserved Instance is Multi-AZ. | | Object 2 | number_of_nfus | double | The number of Normalized Capacity Units. | | Object 2 | number_of_reservations | double | The number of reserved instances. | | Object 2 | purchase_option [*required*] | string | The payment option for the Reserved Instance. | | Object 2 | region [*required*] | string | The AWS region of the Reserved Instance. | | Object 2 | start_date | string | The start date of the commitment. | | Object 2 | term_length | double | The term length in years. | | Object 2 | utilization | double | The utilization percentage of the commitment. | | commitments | Object 3 | object | AWS ElastiCache Reserved Instance commitment details. | | Object 3 | cache_engine [*required*] | string | The cache engine type of the Reserved Instance. | | Object 3 | commitment_id [*required*] | string | The unique identifier of the Reserved Instance. | | Object 3 | expiration_date | string | The expiration date of the commitment. | | Object 3 | instance_type [*required*] | string | The ElastiCache instance type. | | Object 3 | number_of_nfus | double | The number of Normalized Capacity Units. | | Object 3 | number_of_reservations | double | The number of reserved instances. | | Object 3 | purchase_option [*required*] | string | The payment option for the Reserved Instance. | | Object 3 | region [*required*] | string | The AWS region of the Reserved Instance. | | Object 3 | start_date | string | The start date of the commitment. | | Object 3 | term_length | double | The term length in years. | | Object 3 | utilization | double | The utilization percentage of the commitment. | | commitments | Object 4 | object | AWS Savings Plan commitment details. | | Object 4 | commitment_id [*required*] | string | The unique identifier of the Savings Plan. | | Object 4 | committed_spend_per_hour | double | The hourly committed spend for the Savings Plan. | | Object 4 | expiration_date | string | The expiration date of the commitment. | | Object 4 | purchase_option [*required*] | string | The payment option for the Savings Plan. | | Object 4 | savings_plan_type [*required*] | string | The Savings Plan type. | | Object 4 | start_date | string | The start date of the commitment. | | Object 4 | term_length | double | The term length in years. | | Object 4 | utilization | double | The utilization percentage of the commitment. | | commitments | Object 5 | object | Azure Virtual Machine Reserved Instance commitment details. | | Object 5 | benefit_name [*required*] | string | The display name of the Azure reservation. | | Object 5 | commitment_id [*required*] | string | The unique identifier of the Reserved Instance. | | Object 5 | expiration_date | string | The expiration date of the commitment. | | Object 5 | instance_type [*required*] | string | The Azure VM instance type. | | Object 5 | meter_sub_category [*required*] | string | The Azure meter sub-category for the reservation. | | Object 5 | region [*required*] | string | The Azure region of the Reserved Instance. | | Object 5 | start_date | string | The start date of the commitment. | | Object 5 | status [*required*] | enum | Status of an Azure VM Reserved Instance. Allowed enum values: `running`, `expired`, `cancelled`. | | Object 5 | term_length | double | The term length in years. | | Object 5 | utilization | double | The utilization percentage of the commitment. | | commitments | Object 6 | object | Azure Compute Savings Plan commitment details. | | Object 6 | benefit_name [*required*] | string | The display name of the Azure Savings Plan. | | Object 6 | commitment_id [*required*] | string | The unique identifier of the Savings Plan. | | Object 6 | committed_spend_per_hour | double | The hourly committed spend for the Savings Plan. | | Object 6 | expiration_date | string | The expiration date of the commitment. | | Object 6 | start_date | string | The start date of the commitment. | | Object 6 | term_length | double | The term length in years. | | Object 6 | utilization | double | The utilization percentage of the commitment. | | | meta | object | Metadata for a commitments list response. | | meta | committed_spend_unit | object | Unit metadata for a numeric metric. | | committed_spend_unit | family [*required*] | string | The unit family (for example, percentage or money). | | committed_spend_unit | id [*required*] | int64 | The unit identifier. | | committed_spend_unit | name [*required*] | string | The unit name (for example, percent or dollar). | | committed_spend_unit | plural [*required*] | string | The plural form of the unit name. | | committed_spend_unit | scale_factor [*required*] | double | The scale factor for the unit. | | committed_spend_unit | short_name [*required*] | string | The abbreviated unit name (for example, % or $). | {% /tab %} {% tab label="Example" %} ```json { "commitments": [ { "availability_zone": "us-east-1a", "commitment_id": "ri-0123456789abcdef0", "expiration_date": "2025-12-31T00:00:00Z", "instance_type": "m5.xlarge", "number_of_nfus": 8, "number_of_reservations": 2, "offering_class": "standard", "operating_system": "Linux", "purchase_option": "All Upfront", "region": "us-east-1", "start_date": "2023-01-01T00:00:00Z", "term_length": 1, "utilization": 0.85 } ], "meta": { "committed_spend_unit": { "family": "percentage", "id": 17, "name": "percent", "plural": "percent", "scale_factor": 1, "short_name": "%" } } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Required query arguments export provider="aws" export product="ec2" export start="1693526400000" export end="1696118400000" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/cost/commitments/commitment-list?provider=${provider}&product=${product}&start=${start}&end=${end}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get commitments list returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetCommitmentsCommitmentList", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewCloudCostManagementApi(apiClient) resp, r, err := api.GetCommitmentsCommitmentList(ctx, datadogV2.COMMITMENTSPROVIDER_AWS, "product", 9223372036854775807, 9223372036854775807, *datadogV2.NewGetCommitmentsCommitmentListOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CloudCostManagementApi.GetCommitmentsCommitmentList`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `CloudCostManagementApi.GetCommitmentsCommitmentList`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get commitments list returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.CloudCostManagementApi; import com.datadog.api.client.v2.model.CommitmentsListResponse; import com.datadog.api.client.v2.model.CommitmentsProvider; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getCommitmentsCommitmentList", true); CloudCostManagementApi apiInstance = new CloudCostManagementApi(defaultClient); try { CommitmentsListResponse result = apiInstance.getCommitmentsCommitmentList( CommitmentsProvider.AWS, "ec2", 1693526400000L, 1696118400000L); System.out.println(result); } catch (ApiException e) { System.err.println( "Exception when calling CloudCostManagementApi#getCommitmentsCommitmentList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get commitments list returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.cloud_cost_management_api import CloudCostManagementApi from datadog_api_client.v2.model.commitments_provider import CommitmentsProvider configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_commitments_commitment_list"] = True with ApiClient(configuration) as api_client: api_instance = CloudCostManagementApi(api_client) response = api_instance.get_commitments_commitment_list( provider=CommitmentsProvider.AWS, product="product", start=9223372036854775807, end=9223372036854775807, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get commitments list returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_commitments_commitment_list".to_sym] = true end api_instance = DatadogAPIClient::V2::CloudCostManagementAPI.new p api_instance.get_commitments_commitment_list(CommitmentsProvider::AWS, "product", 9223372036854775807, 9223372036854775807) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get commitments list returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_cloud_cost_management::CloudCostManagementAPI; use datadog_api_client::datadogV2::api_cloud_cost_management::GetCommitmentsCommitmentListOptionalParams; use datadog_api_client::datadogV2::model::CommitmentsProvider; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.get_commitments_commitment_list", true); let api = CloudCostManagementAPI::with_config(configuration); let resp = api .get_commitments_commitment_list( CommitmentsProvider::AWS, "product".to_string(), 9223372036854775807, 9223372036854775807, GetCommitmentsCommitmentListOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get commitments list returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.getCommitmentsCommitmentList"] = true; const apiInstance = new v2.CloudCostManagementApi(configuration); const params: v2.CloudCostManagementApiGetCommitmentsCommitmentListRequest = { provider: "aws", product: "product", start: 9223372036854775807, end: 9223372036854775807, }; apiInstance .getCommitmentsCommitmentList(params) .then((data: v2.CommitmentsListResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}