Commitments (Beta)
OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Internal server error
Default error response
Cloud provider (aws, azure, gcp)
awsPossible values: Only return active commitments (default true)
trueText search across commitment fields
nullField to order results by. Includes the monthly-rate metrics (monthly_net_savings, monthly_gross_savings, monthly_premiums, monthly_estimated_rebate) and utilization.
end_datePossible values: Sort descending. Default false — combined with the default order_by=end_date this surfaces the earliest-expiring commitments first, which is the common drilldown.
falseOK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Cloud provider (aws, azure, gcp)
awsPossible values: Only return active commitments (default true)
trueText search across commitment fields
nullField to order results by. Includes the monthly-rate metrics (monthly_net_savings, monthly_gross_savings, monthly_premiums, monthly_estimated_rebate) and utilization.
end_datePossible values: Sort descending. Default false — combined with the default order_by=end_date this surfaces the earliest-expiring commitments first, which is the common drilldown.
false120OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Cloud provider (aws, azure, gcp)
awsPossible values: OK
Total number of active commitments
Number of Archera Guaranteed Commitments
Number of native cloud commitments (not guaranteed)
Cost-weighted average utilization across active commitments (0-1)
Number of commitments expiring in the next 30 days
Number of commitments expiring in the next 90 days
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Start date for utilization/attribution data (YYYY-MM-DD). Defaults to 1 day ago.
nullEnd date for utilization/attribution data (YYYY-MM-DD). Defaults to today.
nullOK
Unique commitment identifier
Cloud provider's ID for this commitment (e.g. AWS reservation ID)
Cloud provider (aws, azure, gcp)
Human-readable commitment name
Commitment type (e.g. 'Compute', 'EC2Instance', 'RDS')
Commitment status (e.g. 'active', 'expired', 'queued')
Whether the commitment is currently active
Whether this is an Archera Guaranteed Commitment
Cloud account ID this commitment is in
Billing/management account ID
When the commitment started
When the commitment expires
Total commitment duration in seconds
When the Archera guarantee period started
When the Archera guarantee lock-in period ends
How the Archera guarantee is delivered. 'rebate': Archera rebates the cost of the unused commitment directly to the user (as cash or credit toward Archera premiums). 'release': Archera takes over the commitment along with remaining payment obligations. Null for non-guaranteed commitments.
Cloud region (e.g. 'us-east-1')
Instance type (e.g. 'm5.xlarge')
Instance family (e.g. 'm5')
Plan type (e.g. 'Compute', 'EC2Instance')
Payment option (e.g. 'no_upfront', 'partial_upfront', 'all_upfront')
Offering class (e.g. 'standard', 'convertible')
Whether the commitment has instance size flexibility
Number of instances covered
Contract term (e.g. 'thirty_day_gris', 'one_year')
Utilization rate (0-1) over the metrics period
One-time total dollars paid at signing for this commitment. NOT a rate — do not sum with monthly-rate fields. 0 for commitments with no-upfront payment options.
Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.
Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Cloud provider (aws, azure, gcp)
awsPossible values: Optional subset of commitments to compare. If omitted, defaults to all currently-active commitments for the provider.
nullOK
Bad Request
Unauthorized
Forbidden
Not Found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Cloud provider (aws, azure, gcp)
awsPossible values: Start date (YYYY-MM-DD)
End date (YYYY-MM-DD, exclusive)
Text search across commitment fields
nullOK
Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.
Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).
Cost-weighted average utilization across the period (0-1)
Total cost of unused commitment capacity for the period
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Last updated
Was this helpful?

