Commitment Plans

API for managing commitment plans

/commitment-plans/{plan_id}

get

Retrieves detailed information about a specific commitment plan, including costs, savings projections, and commitment coverage.

Path parameters

org_idstring · uuidRequired

plan_idstring · uuidRequired

Responses

200

OK

application/json

idstring · uuidRequired

namestringRequired

descriptionstring · nullableOptional

org_idstring · uuidRequired

created_atstring · date-timeRequired

is_calculatingbooleanRequired

statusundefined · enumRequiredPossible values:

max_termstring · nullableRequired

covered_ondemand_cost_hourlynumberRequired

before_ondemand_cost_hourlynumberRequired

before_reserved_cost_hourlynumberRequired

amortized_cost_hourlynumberRequired

recurring_cost_hourlynumberRequired

upfront_cost_hourlynumberRequired

before_cost_hourlynumberRequired

after_cost_hourlynumberRequired

total_cost_hourlynumberRequired

savings_hourlynumberRequired

fee_hourlynumberRequired

commitment_coveragenumberRequired

minimum_commitment_costnumberRequired

breakeven_hoursnumberRequired

total_savingsnumberRequired

monthly_savingsnumberRequired

total_monthly_before_costnumberRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/commitment-plans/{plan_id}

HTTPcURLJavaScriptPython

GET /v1/org/{org_id}/commitment-plans/{plan_id} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": null,
  "org_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-08-09T02:58:31.641Z",
  "is_calculating": true,
  "status": "new",
  "max_term": null,
  "covered_ondemand_cost_hourly": 1,
  "before_ondemand_cost_hourly": 1,
  "before_reserved_cost_hourly": 1,
  "amortized_cost_hourly": 1,
  "recurring_cost_hourly": 1,
  "upfront_cost_hourly": 1,
  "before_cost_hourly": 1,
  "after_cost_hourly": 1,
  "total_cost_hourly": 1,
  "savings_hourly": 1,
  "fee_hourly": 1,
  "commitment_coverage": 1,
  "minimum_commitment_cost": 1,
  "breakeven_hours": 1,
  "total_savings": 1,
  "monthly_savings": 1,
  "total_monthly_before_cost": 1
}

/commitment-plans/{plan_id}/apply

post

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.

Path parameters

org_idstring · uuidRequired

plan_idstring · uuidRequired

Responses

200

OK

application/json

idstring · uuidRequired

namestringRequired

descriptionstring · nullableOptional

org_idstring · uuidRequired

created_atstring · date-timeRequired

is_calculatingbooleanRequired

statusundefined · enumRequiredPossible values:

max_termstring · nullableRequired

covered_ondemand_cost_hourlynumberRequired

before_ondemand_cost_hourlynumberRequired

before_reserved_cost_hourlynumberRequired

amortized_cost_hourlynumberRequired

recurring_cost_hourlynumberRequired

upfront_cost_hourlynumberRequired

before_cost_hourlynumberRequired

after_cost_hourlynumberRequired

total_cost_hourlynumberRequired

savings_hourlynumberRequired

fee_hourlynumberRequired

commitment_coveragenumberRequired

minimum_commitment_costnumberRequired

breakeven_hoursnumberRequired

total_savingsnumberRequired

monthly_savingsnumberRequired

total_monthly_before_costnumberRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

post/v1/org/{org_id}/commitment-plans/{plan_id}/apply

HTTPcURLJavaScriptPython

POST /v1/org/{org_id}/commitment-plans/{plan_id}/apply HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": null,
  "org_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-08-09T02:58:31.641Z",
  "is_calculating": true,
  "status": "new",
  "max_term": null,
  "covered_ondemand_cost_hourly": 1,
  "before_ondemand_cost_hourly": 1,
  "before_reserved_cost_hourly": 1,
  "amortized_cost_hourly": 1,
  "recurring_cost_hourly": 1,
  "upfront_cost_hourly": 1,
  "before_cost_hourly": 1,
  "after_cost_hourly": 1,
  "total_cost_hourly": 1,
  "savings_hourly": 1,
  "fee_hourly": 1,
  "commitment_coverage": 1,
  "minimum_commitment_cost": 1,
  "breakeven_hours": 1,
  "total_savings": 1,
  "monthly_savings": 1,
  "total_monthly_before_cost": 1
}

/commitment-plans/default

get

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.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider to get default plans for

Example: awsPossible values:

Responses

200

OK

application/json

idstring · uuidRequired

namestringRequired

descriptionstring · nullableOptional

org_idstring · uuidRequired

created_atstring · date-timeRequired

is_calculatingbooleanRequired

statusundefined · enumRequiredPossible values:

max_termstring · nullableRequired

covered_ondemand_cost_hourlynumberRequired

before_ondemand_cost_hourlynumberRequired

before_reserved_cost_hourlynumberRequired

amortized_cost_hourlynumberRequired

recurring_cost_hourlynumberRequired

upfront_cost_hourlynumberRequired

before_cost_hourlynumberRequired

after_cost_hourlynumberRequired

total_cost_hourlynumberRequired

savings_hourlynumberRequired

fee_hourlynumberRequired

commitment_coveragenumberRequired

minimum_commitment_costnumberRequired

breakeven_hoursnumberRequired

total_savingsnumberRequired

monthly_savingsnumberRequired

total_monthly_before_costnumberRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/commitment-plans/default

HTTPcURLJavaScriptPython

GET /v1/org/{org_id}/commitment-plans/default?provider=aws HTTP/1.1
Accept: */*

[
  {
    "id": "11111111-1111-1111-1111-111111111111",
    "name": "Recommended",
    "description": "string",
    "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
    "created_at": "2025-06-01T08:00:00Z",
    "is_calculating": false,
    "status": "active",
    "max_term": "string",
    "covered_ondemand_cost_hourly": 3.21,
    "before_ondemand_cost_hourly": 4.56,
    "before_reserved_cost_hourly": 0,
    "amortized_cost_hourly": 2.98,
    "recurring_cost_hourly": 0.23,
    "upfront_cost_hourly": 0,
    "before_cost_hourly": 4.56,
    "after_cost_hourly": 3.21,
    "total_cost_hourly": 3.44,
    "savings_hourly": 1.12,
    "fee_hourly": 0.1,
    "commitment_coverage": 0.7,
    "minimum_commitment_cost": 1200,
    "breakeven_hours": 300,
    "total_savings": 980,
    "monthly_savings": 82,
    "total_monthly_before_cost": 330
  },
  {
    "id": "22222222-2222-2222-2222-222222222222",
    "name": "Balanced",
    "description": "string",
    "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
    "created_at": "2025-06-01T08:00:00Z",
    "is_calculating": false,
    "status": "active",
    "max_term": "string",
    "covered_ondemand_cost_hourly": 4.85,
    "before_ondemand_cost_hourly": 6.5,
    "before_reserved_cost_hourly": 0,
    "amortized_cost_hourly": 3.75,
    "recurring_cost_hourly": 0.54,
    "upfront_cost_hourly": 0,
    "before_cost_hourly": 6.5,
    "after_cost_hourly": 4.29,
    "total_cost_hourly": 4.83,
    "savings_hourly": 1.67,
    "fee_hourly": 0.15,
    "commitment_coverage": 0.85,
    "minimum_commitment_cost": 2000,
    "breakeven_hours": 450,
    "total_savings": 1460,
    "monthly_savings": 122,
    "total_monthly_before_cost": 440
  },
  {
    "id": "33333333-3333-3333-3333-333333333333",
    "name": "High Savings",
    "description": "string",
    "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
    "created_at": "2025-06-01T08:00:00Z",
    "is_calculating": false,
    "status": "active",
    "max_term": "string",
    "covered_ondemand_cost_hourly": 7.25,
    "before_ondemand_cost_hourly": 8.9,
    "before_reserved_cost_hourly": 0,
    "amortized_cost_hourly": 5.1,
    "recurring_cost_hourly": 0.85,
    "upfront_cost_hourly": 0,
    "before_cost_hourly": 8.9,
    "after_cost_hourly": 5.95,
    "total_cost_hourly": 6.8,
    "savings_hourly": 2.1,
    "fee_hourly": 0.25,
    "commitment_coverage": 0.95,
    "minimum_commitment_cost": 3500,
    "breakeven_hours": 620,
    "total_savings": 2540,
    "monthly_savings": 220,
    "total_monthly_before_cost": 650
  }
]

/commitment-plans/recommended

get

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.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider to get the recommended plan for

Example: awsPossible values:

Responses

200

OK

application/json

204

No Content

No content

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/commitment-plans/recommended

HTTPcURLJavaScriptPython

GET /v1/org/{org_id}/commitment-plans/recommended?provider=aws HTTP/1.1
Accept: */*

No content

/commitment-plans/{plan_id}/line-items

get

Retrieves line items for a specific commitment plan, including offer details, costs, and savings information. Line items represent individual commitment purchases within the plan.

Path parameters

org_idstring · uuidRequired

plan_idstring · uuidRequired

Query parameters

order_bystring,null · enum · nullableOptional

Field to order results by

Default: idExample: created_atPossible values:

descboolean · nullableOptional

Sort in descending order if true

Default: nullExample: true

segment_idstringOptional

Filter line items by segment ID

Example: 550e8400-e29b-41d4-a716-446655440000

resource_match_idsstring · uuid[]Optional

Filter line items by specific resource match IDs

Example: ["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"]

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 20

Responses

200

OK

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/commitment-plans/{plan_id}/line-items

HTTPcURLJavaScriptPython

GET /v1/org/{org_id}/commitment-plans/{plan_id}/line-items HTTP/1.1
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "plan_id": "123e4567-e89b-12d3-a456-426614174000",
    "offer_id": "123e4567-e89b-12d3-a456-426614174000",
    "lease_menu_item_id": null,
    "account_id": null,
    "recommended_quantity": 1,
    "selected_quantity": 1,
    "recommended_commitment": 1,
    "selected_commitment": 1,
    "is_selected": true,
    "after_amortized_cost": 1,
    "upfront_cost": 1,
    "recurring_cost": 1,
    "before_cost": 1,
    "before_ondemand_cost": 1,
    "before_reserved_cost": 1,
    "covered_ondemand_cost": 1,
    "after_covered_units": 1,
    "total_cost": 1,
    "monthly_cost": 1,
    "savings": 1,
    "monthly_savings": 1,
    "total_savings": 1,
    "fee": 1,
    "discount_rate": 1,
    "breakeven_hours": 1,
    "contract_term": "one_year_gris",
    "payment_option": "No Upfront",
    "contract_spec": {
      "commitment_type": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "term": "one_year_gris",
      "payment_option": "no_upfront"
    },
    "offer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "provider": "aws",
      "provider_offering_id": "text",
      "type": "text",
      "display_name": null,
      "leased_display_name": null,
      "region": null,
      "duration_seconds": 1,
      "upfront_cost": 1,
      "recurring_cost": 1,
      "offering_class": "standard",
      "payment_option": "No Upfront",
      "offering_id": null,
      "product_description": null,
      "instance_family": null,
      "instance_type": null,
      "tenancy": null,
      "az": null,
      "is_multi_az": null,
      "is_flexible": null,
      "plan_type": null
    }
  }
]

/commitment-plans/{plan_id}/resource-matches

get

Retrieves resource matches for a specific commitment plan, showing how resources map to commitment purchases with cost and usage details.

Path parameters

org_idstring · uuidRequired

plan_idstring · uuidRequired

Query parameters

order_bystring,null · enum · nullableOptional

Field to order results by

Default: covered_ondemand_costPossible values:

descbooleanOptional

Sort in descending order if true

Default: true

start_datestring · dateRequired

Start date for resource usage data

Example: 2024-01-01

end_datestring · dateRequired

End date for resource usage data

Example: 2024-01-31

line_item_idsstring · uuid[]Optional

Filter by specific line item IDs

Example: ["550e8400-e29b-41d4-a716-446655440000"]

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 20

Responses

200

OK

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/commitment-plans/{plan_id}/resource-matches

HTTPcURLJavaScriptPython

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: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "total_units": 1,
    "before_uncovered_units": 1,
    "after_covered_units": 1,
    "after_uncovered_units": 1,
    "ondemand_price": 1,
    "if_all_ondemand_cost": 1,
    "before_ondemand_cost": 1,
    "after_ondemand_cost": 1,
    "covered_ondemand_cost": 1,
    "before_reserved_cost": 1,
    "after_reserved_cost": 1,
    "before_cost": 1,
    "after_cost": 1,
    "monthly_before_cost": 1,
    "monthly_after_cost": 1,
    "monthly_after_reserved_cost": 1,
    "monthly_after_ondemand_cost": 1,
    "average_savings": 1,
    "average_monthly_savings": 1,
    "usage_type": "running",
    "coverage": 1,
    "resource": {
      "id": "text",
      "resource_id": "123e4567-e89b-12d3-a456-426614174000",
      "provider": "aws",
      "provider_resource_id": "arn:aws:ec2:us-west-2:123456789012:instance/i-1234567890abcdef0",
      "is_spot": true,
      "name": null,
      "resource_group": null,
      "usage_end": "2026-08-09",
      "usage_start": "2026-08-09",
      "tags": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created_at": "2026-08-09",
      "updated_at": "2026-08-09",
      "instance_id": "text",
      "billing_account_id": "text",
      "sub_account_id": "text",
      "sku_title": "text",
      "sku_name": null,
      "availability_zone": null,
      "cache_engine": null,
      "database_engine": null,
      "description": null,
      "family": null,
      "full_region_name": null,
      "has_ondemand_terms": null,
      "instance_type": null,
      "instance_type_family": null,
      "is_reservable": null,
      "license_model": null,
      "location_type": null,
      "normalization_size_factor": null,
      "operating_system": null,
      "pre_installed_sw": null,
      "price_currency": null,
      "provider_service": null,
      "provider_sku_id": null,
      "publication_date": null,
      "region": null,
      "service": null,
      "tenancy": null,
      "usage_type": null,
      "version": null,
      "vpc_networking_support": null,
      "ondemand_usage_unit": null
    }
  }
]

/commitment-plans/{plan_id}/comparison

get

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].

Path parameters

org_idstring · uuidRequired

plan_idstring · uuidRequired

Query parameters

line_item_idsstring · uuid[] · nullableOptional

Optional subset of line items to compare. If omitted, defaults to all selected line items in the plan.

Default: null

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v1/org/{org_id}/commitment-plans/{plan_id}/comparison

HTTPcURLJavaScriptPython

GET /v1/org/{org_id}/commitment-plans/{plan_id}/comparison HTTP/1.1
Accept: */*

{
  "current_totals": {
    "commitment_financials_monthly_rate": {
      "commitment_cost": {
        "total": 1,
        "breakdown": {
          "cloud_provider_cost": {
            "total": 1,
            "breakdown": {
              "recurring": 1,
              "amortized_upfront": 1
            }
          },
          "archera_premium": 1
        }
      },
      "commitment_savings": {
        "net": 1,
        "gross": 1
      },
      "covered_ondemand_cost": 1
    },
    "commitment_upfront_cost": 1
  },
  "hypothetical_totals": [
    {
      "contract_term": "one_year_gris",
      "payment_option": "no_upfront",
      "commitment_financials_monthly_rate": {
        "commitment_cost": {
          "total": 1,
          "breakdown": {
            "cloud_provider_cost": {
              "total": 1,
              "breakdown": {
                "recurring": 1,
                "amortized_upfront": 1
              }
            },
            "archera_premium": 1
          }
        },
        "commitment_savings": {
          "net": 1,
          "gross": 1
        },
        "covered_ondemand_cost": 1
      },
      "commitment_upfront_cost": 1,
      "delta_vs_current": {
        "monthly_net_savings": 1,
        "monthly_commitment_cost": 1,
        "upfront_cost": 1
      },
      "line_items": [
        {
          "line_item_id": "123e4567-e89b-12d3-a456-426614174000",
          "actual_term": "one_year_gris",
          "actual_payment_option": "no_upfront",
          "actual_term_reason": "exact_match"
        }
      ]
    }
  ],
  "data": [
    {
      "line_item_id": "123e4567-e89b-12d3-a456-426614174000",
      "current": {
        "is_current": true,
        "offer_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "aws",
          "type": "text",
          "region": null,
          "duration_seconds": 1,
          "instance_type": null,
          "instance_family": null,
          "offering_class": "standard",
          "payment_option": "no_upfront",
          "plan_type": null,
          "product_description": null,
          "display_name": null,
          "guaranteed_display_name": null,
          "is_flexible": null
        },
        "lease_menu_item_id": null,
        "selected_amount": 1,
        "contract_term": "one_year_gris",
        "discount_rate": 1,
        "breakeven_days": null,
        "commitment_upfront_cost": 1,
        "commitment_financials_monthly_rate": {
          "commitment_cost": {
            "total": 1,
            "breakdown": {
              "cloud_provider_cost": {
                "total": 1,
                "breakdown": {
                  "recurring": 1,
                  "amortized_upfront": 1
                }
              },
              "archera_premium": 1
            }
          },
          "commitment_savings": {
            "net": 1,
            "gross": 1
          },
          "covered_ondemand_cost": 1
        },
        "delta_vs_current": {
          "monthly_net_savings": 1,
          "upfront_cost": 1,
          "discount_rate": 1,
          "breakeven_days": null
        }
      },
      "candidates": [
        {
          "is_current": true,
          "offer_id": "123e4567-e89b-12d3-a456-426614174000",
          "offer": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "provider": "aws",
            "type": "text",
            "region": null,
            "duration_seconds": 1,
            "instance_type": null,
            "instance_family": null,
            "offering_class": "standard",
            "payment_option": "no_upfront",
            "plan_type": null,
            "product_description": null,
            "display_name": null,
            "guaranteed_display_name": null,
            "is_flexible": null
          },
          "lease_menu_item_id": null,
          "selected_amount": 1,
          "contract_term": "one_year_gris",
          "discount_rate": 1,
          "breakeven_days": null,
          "commitment_upfront_cost": 1,
          "commitment_financials_monthly_rate": {
            "commitment_cost": {
              "total": 1,
              "breakdown": {
                "cloud_provider_cost": {
                  "total": 1,
                  "breakdown": {
                    "recurring": 1,
                    "amortized_upfront": 1
                  }
                },
                "archera_premium": 1
              }
            },
            "commitment_savings": {
              "net": 1,
              "gross": 1
            },
            "covered_ondemand_cost": 1
          },
          "delta_vs_current": {
            "monthly_net_savings": 1,
            "upfront_cost": 1,
            "discount_rate": 1,
            "breakeven_days": null
          }
        }
      ]
    }
  ]
}