Commitment Plans
API for managing commitment plans
Retrieves detailed information about a specific commitment plan, including costs, savings projections, and commitment coverage.
OK
Bad request
Unauthorized
Forbidden
Not Found
Method not allowed
Conflict
Internal server error
Default error response
Error code
Error name
GET /v1/org/{org_id}/commitment-plans/{plan_id} HTTP/1.1
Accept: */*
{
"code": 1,
"status": "text",
"message": "text",
"errors": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"error": "text",
"timestamp": "text",
"type": "text"
}Executes a commitment purchase plan, initiating the commitment purchase process. This action will mark the plan as edited and record the user who initiated the purchase. The plan will then be processed for actual commitment purchases according to the plan specifications.
OK
Bad request
Unauthorized
Forbidden
Not Found
Method not allowed
Conflict
Internal server error
Default error response
Error code
Error name
POST /v1/org/{org_id}/commitment-plans/{plan_id}/apply HTTP/1.1
Accept: */*
{
"code": 1,
"status": "text",
"message": "text",
"errors": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"error": "text",
"timestamp": "text",
"type": "text"
}Retrieves the three default Archera commitment plans (High Savings, Balanced, Recommended) for the specified cloud provider. These plans are automatically generated based on the organization's usage patterns. Each plan offers different trade-offs between cost savings and flexibility.
Cloud provider to get default plans for
awsPossible values: OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Error code
Error name
GET /v1/org/{org_id}/commitment-plans/default?provider=aws HTTP/1.1
Accept: */*
{
"code": 1,
"status": "text",
"message": "text",
"errors": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"error": "text",
"timestamp": "text",
"type": "text"
}Retrieves only the recommended Archera commitment plan for the specified cloud provider. This is the optimal plan automatically selected based on the organization's usage patterns, balancing cost savings with flexibility. Returns a 204 No Content response if no recommended plan is available for the specified provider.
Cloud provider to get the recommended plan for
awsPossible values: OK
No Content
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Error code
Error name
GET /v1/org/{org_id}/commitment-plans/recommended?provider=aws HTTP/1.1
Accept: */*
{
"code": 1,
"status": "text",
"message": "text",
"errors": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"error": "text",
"timestamp": "text",
"type": "text"
}Retrieves line items for a specific commitment plan, including offer details, costs, and savings information. Line items represent individual commitment purchases within the plan.
Field to order results by
idExample: created_atPossible values: Sort in descending order if true
nullExample: trueFilter line items by segment ID
550e8400-e29b-41d4-a716-446655440000Filter line items by specific resource match IDs
["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"]120OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Error code
Error name
GET /v1/org/{org_id}/commitment-plans/{plan_id}/line-items HTTP/1.1
Accept: */*
{
"code": 1,
"status": "text",
"message": "text",
"errors": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"error": "text",
"timestamp": "text",
"type": "text"
}Retrieves resource matches for a specific commitment plan, showing how resources map to commitment purchases with cost and usage details.
Field to order results by
covered_ondemand_costPossible values: Sort in descending order if true
trueStart date for resource usage data
2024-01-01End date for resource usage data
2024-01-31Filter by specific line item IDs
["550e8400-e29b-41d4-a716-446655440000"]120OK
Bad request
Unauthorized
Forbidden
Not found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Error code
Error name
GET /v1/org/{org_id}/commitment-plans/{plan_id}/resource-matches?start_date=2024-01-01&end_date=2024-01-31 HTTP/1.1
Accept: */*
{
"code": 1,
"status": "text",
"message": "text",
"errors": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"error": "text",
"timestamp": "text",
"type": "text"
}Returns per-line-item offer alternatives plus plan-wide rollups for each (contract_term, payment_option) hypothetical. Designed to answer 'what would the plan look like at 3-year' in a single call: hypothetical_totals carries the rolled-up financials and delta_vs_current, with per-line-item resolution exposed for transparency. Each line item lands at the target term when available, else the longest available term <= target with the same payment option (GRI preferred within tier), else its current term. Defaults: line_item_ids=all selected, contract_terms=all distinct in candidates, payment_options=[no_upfront].
Optional subset of line items to compare. If omitted, defaults to all selected line items in the plan.
nullOK
Bad Request
Unauthorized
Forbidden
Not Found
Method not allowed
Conflict
Unprocessable Content
Internal server error
Default error response
Error code
Error name
GET /v1/org/{org_id}/commitment-plans/{plan_id}/comparison HTTP/1.1
Accept: */*
{
"code": 1,
"status": "text",
"message": "text",
"errors": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"error": "text",
"timestamp": "text",
"type": "text"
}Last updated
Was this helpful?

