### API for managing commitment plans

### /commitment-plans/{plan_id}

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

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

#### Path parameters
- **org_id**  string · uuid  Required
- **plan_id**  string · uuid  Required

#### Responses
- **200 OK**

```json
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": null,
    "org_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-07-27T19:48:09.646Z",
    "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/v1/org/{org_id}/commitment-plans/{plan_id}/apply

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_id**  string · uuid Required
- **plan_id**  string · uuid Required

#### Responses
- **200 OK**

### /commitment-plans/default

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

Retrieves the three default Archera commitment plans (High Savings, Balanced, Recommended) for the specified cloud provider. Each plan offers different trade-offs between cost savings and flexibility.

#### Path parameters
- **org_id**  string · uuid  Required

#### Query parameters
- **provider**  string · enum  Required  Cloud provider to get default plans for

#### Responses
- **200 OK**

```json
  [
    {
      "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/v1/org/{org_id}/commitment-plans/recommended

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.

#### Path parameters
- **org_id**  string · uuid  Required

#### Query parameters
- **provider**  string · enum  Required  Cloud provider to get the recommended plan for

#### Responses
- **200 OK**

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

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

Retrieves line items for a specific commitment plan, including offer details, costs, and savings information.

#### Path parameters
- **org_id**  string · uuid  Required
- **plan_id**  string · uuid  Required

#### Query parameters
- **order_by**  string, null · enum · nullable Optional  Field to order results by
- **desc**  boolean · nullable Optional  Sort in descending order if true
- **segment_id**  string Optional  Filter line items by segment ID
- **page**  integer · min: 1 Optional Default: 1
- **page_size**  integer · min: 1 · max: 100 Optional Default: 20

#### Responses
- **200 OK**

```json
  [
    {
      "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/v1/org/{org_id}/commitment-plans/{plan_id}/resource-matches

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

#### Path parameters
- **org_id**  string · uuid  Required
- **plan_id**  string · uuid  Required

#### Query parameters
- **order_by**  string, null · enum · nullable Optional  Field to order results by
- **desc**  boolean Optional  Sort in descending order if true
- **start_date**  string · date Required  Start date for resource usage data
- **end_date**  string · date Required  End date for resource usage data
- **line_item_ids**  string · uuid[] Optional  Filter by specific line item IDs
- **page**  integer · min: 1 Optional Default: 1
- **page_size**  integer · min: 1 · max: 100 Optional Default: 20

#### Responses
- **200 OK**

```json
  [
    {
      "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-07-27",
        "usage_start": "2026-07-27",
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "created_at": "2026-07-27",
        "updated_at": "2026-07-27",
        "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/v1/org/{org_id}/commitment-plans/{plan_id}/comparison

Returns per-line-item offer alternatives plus plan-wide rollups for each (contract_term, payment_option).

#### Path parameters
- **org_id**  string · uuid  Required
- **plan_id**  string · uuid  Required

#### Query parameters
- **line_item_ids**  string · uuid[] · nullable Optional  Optional subset of line items to compare.
- **contract_terms**  string · enum[] · nullable Optional  Optional list of target terms to roll up.
- **payment_options**  string · enum[] Optional  Payment options to include.

#### Responses
- **200 OK**

```json
  {
    "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
            }
          }
        ]
      }
    }
  ]
  ```