Commitments
API for retrieving and analyzing cloud commitment inventory, including Reserved Instances, Savings Plans, and Azure Reserved VM Instances. Provides access to detailed commitment data, utilization metrics, and cost savings information.
Retrieves a paginated list of commitments for the specified organization and time period. Returns detailed information about each commitment including utilization, savings, and status. Results can be filtered by provider, search term, and custom criteria, and sorted by various attributes.
Text to search across multiple columns (case-insensitive partial match)
us-east-1JSON object specifying field-specific filter criteria
{"field": "type", "op": "=", "value": "Standard"}Sort in descending order if true
trueExample: trueField to order results by
end_dateExample: created_atPossible values: Cloud provider to filter commitments by
awsPossible values: Start date for the commitment period (YYYY-MM-DD)
2023-01-01End date for the commitment period (YYYY-MM-DD)
2023-12-31110OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
GET /v1/org/{org_id}/commitments?provider=aws&start_date=2023-01-01&end_date=2023-12-31 HTTP/1.1
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"provider": "aws",
"display_name": "text",
"leased_display_name": "text",
"provider_reservation_id": "text",
"account_id": null,
"billing_account_id": null,
"type": "text",
"region": null,
"duration_seconds": null,
"reservation_end": null,
"reservation_start": null,
"transfer_reservation_start": null,
"transfer_reservation_end": null,
"start_date": null,
"end_date": null,
"status": "active",
"is_leased": true,
"is_active": true,
"lease": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"fee_type": "text",
"fee_rate": 1,
"is_rebate": true,
"lockin_months": 1,
"term_months": 1
},
"lease_start": null,
"lease_lockin_date": null,
"upfront_cost": 1,
"recurring_cost": 1,
"is_flexible": null,
"payment_option": "No Upfront",
"offering_class": "standard",
"offering_id": null,
"instance_count": null,
"effective_instance_count": null,
"product_description": null,
"instance_family": null,
"instance_type": null,
"tenancy": null,
"az": null,
"is_multi_az": null,
"plan_type": null,
"scope": "shared",
"name": null,
"order_id": null,
"resource_group": null,
"instance_flexibility": null,
"savings": null,
"monthly_savings": null,
"net_savings": null,
"utilization": null,
"potential_savings": null,
"running_hours": null,
"amortized_cost": null,
"daily_utilizations": [
{
"date": "2026-01-01",
"reservation_utilization": 1,
"covered_cost": 1,
"cost": 1,
"potential_savings": null,
"running_hours": null,
"savings": 1,
"unutilized_commit": 1,
"gri_fees": 1,
"net_savings": 1
}
]
}
]Text to search across multiple columns (case-insensitive partial match)
us-east-1JSON object specifying field-specific filter criteria
{"field": "type", "op": "=", "value": "Standard"}Sort in descending order if true
trueExample: trueField to order results by
end_dateExample: created_atPossible values: Cloud provider to filter commitments by
awsPossible values: Start date for the commitment period (YYYY-MM-DD)
2023-01-01End date for the commitment period (YYYY-MM-DD)
2023-12-31OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
GET /v1/org/{org_id}/commitments/ids?provider=aws&start_date=2023-01-01&end_date=2023-12-31 HTTP/1.1
Accept: */*
{
"ids": [
"text"
]
}Generates time-series chart data for commitment metrics over the specified time period. The data includes daily or monthly values for commitment spend, utilization, locked vs unlocked commitments, and realized savings. Results are aggregated by day or month depending on the date range selected.
Future Projections: When the end_date extends into the future, the API returns projected values based on current commitment utilization patterns. Each data point includes an is_projection field that indicates whether the values are historical (false) or projected (true). Projected values assume that active commitments will continue with their current utilization rates through their expiration dates. This is useful for forecasting future commitment costs and savings based on existing commitments.
Optional JSON filter criteria for commitment data
{"field": "type", "op": "=", "value": "Compute Instance"}Cloud provider to filter commitments by
awsPossible values: Start date for the chart data (YYYY-MM-DD)
2023-01-01End date for the chart data (YYYY-MM-DD)
2023-12-31OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
GET /v1/org/{org_id}/commitments/chart?provider=aws&start_date=2023-01-01&end_date=2023-12-31 HTTP/1.1
Accept: */*
{
"data": [
{
"date": "text",
"remaining_commit": 1,
"locked_commit": 1,
"unlocked_commit": 1,
"savings": 1,
"net_savings": 1,
"utilization": 1,
"unutilized_commit": 1,
"is_projection": true
}
]
}Last updated
Was this helpful?

