Sign in

v1

latestOpenAPI 3.1.02026-08-042955230.1 KB
Commitments

/commitments

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.

get/v1/org/{org_id}/commitments

Query parameters

searchstring
Example:us-east-1

Text to search across multiple columns (case-insensitive partial match)

filterobject nullable

JSON object specifying field-specific filter criteria

descboolean

Sort in descending order if true

order_by'duration_seconds' | 'start_date' | 'end_date' | 'upfront_cost' | 'amortized_cost' | 'recurring_cost' | 'created_at' | 'updated_at' | 'is_leased' | 'account_id' | 'type' | 'status' | 'scope' | 'reservation_end' | 'utilization' | 'monthly_savings' | 'null' nullable
Example:created_at

Field to order results by

provider'aws' | 'azure' | 'gcp' required
Example:aws

Cloud provider to filter commitments by

start_datestring date required
Example:2023-01-01

Start date for the commitment period (YYYY-MM-DD)

end_datestring date required
Example:2023-12-31

End date for the commitment period (YYYY-MM-DD)

pageinteger
page_sizeinteger

Response

OK

idstring uuid required
provider'aws' | 'azure' | 'gcp' required
display_namestring required
leased_display_namestring required
provider_reservation_idstring required
account_idstring nullable required
master_account_idstring nullable required
billing_account_idstring nullable required
typestring required
regionstring nullable required
duration_secondsinteger nullable required
reservation_endstring nullable required
reservation_startstring nullable required
transfer_reservation_startstring date-time nullable required
transfer_reservation_endstring date-time nullable required
start_datestring date-time nullable required
end_datestring date-time nullable required
status'active' | 'locked' | 'new' | 'reselling' | 'unlocked' | 'unknown' | 'cancelled' | 'expired' | 'recently_expired' | 'resold' | 'removed' required
is_leasedboolean required
is_activeboolean required
lease_startstring date-time nullable required
lease_lockin_datestring date-time nullable required
upfront_costnumber required
recurring_costnumber required
is_flexibleboolean nullable required
{"stackTrail":"components:schemas:PublicCommitment:properties:payment_option","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:PublicCommitment:properties:offering_class","oasType":"schema","type":"unknown"}
offering_idstring nullable required
instance_countinteger nullable required
effective_instance_countinteger nullable required
product_descriptionstring nullable required
instance_familystring nullable required
instance_typestring nullable required
tenancystring nullable required
azstring nullable required
is_multi_azboolean nullable required
plan_typestring nullable required
{"stackTrail":"components:schemas:PublicCommitment:properties:scope","oasType":"schema","type":"unknown"}
namestring nullable required
order_idstring nullable required
resource_groupstring nullable required
instance_flexibilityboolean nullable required
savingsnumber nullable required
monthly_savingsnumber nullable required
net_savingsnumber nullable required
utilizationnumber nullable required
potential_savingsnumber nullable required
running_hoursnumber nullable required
amortized_costnumber nullable required