Cost Estimates (Beta)

Saved cost-estimate baskets — catalog SKUs with quantities, priced live as monthly cost and savings under per-line-item commitment selections.

List cost estimates

get

Returns the org's cost estimates for the requested provider, most recently updated first.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

Responses

200

OK

application/json

idstring · uuidRequired

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Possible values:

namestringRequired

descriptionstring · nullableRequired

line_countintegerRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

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/beta/v1/org/{org_id}/cost-estimates

GET /beta/v1/org/{org_id}/cost-estimates?provider=aws HTTP/1.1
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "provider": "aws",
    "name": "text",
    "description": "text",
    "line_count": 1,
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
]

Create a cost estimate

post

Creates a provider-specific cost estimate, optionally with initial lines from that provider. When source_draft_id is provided the create is idempotent per org: posting the same draft id again returns the existing estimate unchanged, so a retried post-signup import cannot duplicate.

Path parameters

org_idstring · uuidRequired

Body

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

namestring · min: 1 · max: 255OptionalDefault: Untitled estimate

descriptionstring · nullableOptionalDefault: null

source_draft_idstring · uuid · nullableOptional

Client-generated UUID of a logged-out draft. Unique per org: posting the same value again returns the existing estimate instead of creating a duplicate (idempotent import).

Default: null

Responses

200

OK

application/json

idstring · uuidRequired

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Possible values:

namestringRequired

descriptionstring · nullableRequired

source_draft_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

pricingany ofOptional

Computed pricing; null when include_pricing=false

or

object · nullableOptional

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

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

post/beta/v1/org/{org_id}/cost-estimates

POST /beta/v1/org/{org_id}/cost-estimates HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 554

{
  "provider": "aws",
  "name": "Untitled estimate",
  "description": "text",
  "source_draft_id": "123e4567-e89b-12d3-a456-426614174000",
  "line_items": [
    {
      "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
      "catalog_sku_org_id": "text",
      "quantity": 1,
      "quantity_basis": "resource_count",
      "label": "text",
      "is_enabled": true,
      "selected_commitment_option": {
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "commitment_type": "text",
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer_org_id": "text",
        "offer_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "aws",
  "name": "text",
  "description": "text",
  "source_draft_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "line_items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "catalog_sku": {
        "catalog_sku_org_id": "text",
        "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "aws",
        "provider_sku_id": "text",
        "display_name": "text",
        "instance_type": "text",
        "service": "text",
        "provider_service": "text",
        "region_code": "text",
        "operating_system": "text",
        "database_engine": "text",
        "cache_engine": "text",
        "usage_type": "text"
      },
      "usage_unit": "text",
      "label": "text",
      "quantity": 1,
      "quantity_basis": "resource_count",
      "is_enabled": true,
      "selected_commitment_option": {
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "commitment_type": "text",
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer_org_id": "text",
        "offer_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pricing": {
    "line_items": [
      {
        "line_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "ok",
        "detail": "text",
        "ondemand_monthly_cost": 1,
        "matched_commitment_option": {
          "offer_id": "123e4567-e89b-12d3-a456-426614174000",
          "offer_org_id": "text",
          "offer": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "provider": "aws",
            "type": "text",
            "region": "text",
            "duration_seconds": 1,
            "instance_type": "text",
            "instance_family": "text",
            "offering_class": "standard",
            "payment_option": "no_upfront",
            "plan_type": "text",
            "product_description": "text",
            "display_name": "text",
            "guaranteed_display_name": "text",
            "is_flexible": true
          },
          "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
          "selected_amount": 1,
          "commitment_type": "text",
          "contract_term": "one_year_gris",
          "payment_option": "no_upfront",
          "discount_rate": 1,
          "breakeven_days": 1,
          "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
          }
        },
        "commitment_options": [
          {
            "offer_id": "123e4567-e89b-12d3-a456-426614174000",
            "offer_org_id": "text",
            "offer": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "provider": "aws",
              "type": "text",
              "region": "text",
              "duration_seconds": 1,
              "instance_type": "text",
              "instance_family": "text",
              "offering_class": "standard",
              "payment_option": "no_upfront",
              "plan_type": "text",
              "product_description": "text",
              "display_name": "text",
              "guaranteed_display_name": "text",
              "is_flexible": true
            },
            "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
            "selected_amount": 1,
            "commitment_type": "text",
            "contract_term": "one_year_gris",
            "payment_option": "no_upfront",
            "discount_rate": 1,
            "breakeven_days": 1,
            "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
            }
          }
        ]
      }
    ],
    "totals": {
      "ondemand_monthly_cost": 1,
      "estimated_monthly_cost": 1,
      "monthly_net_savings": 1,
      "commitment_upfront_cost": 1
    }
  }
}

Get a cost estimate with computed pricing

get

Returns the estimate document plus pricing computed live against the current catalog and offers: per-line on-demand monthly cost, the re-matched selected option, and totals (estimated monthly cost and savings vs on-demand). Full per-line commitment option grids are omitted unless include_options=true — read one line's grid via GET .../line-items/{line_item_id} instead. Nothing in pricing is ever persisted.

Path parameters

org_idstring · uuidRequired

estimate_idstring · uuidRequired

Query parameters

only_most_flexible_commitment_typebooleanOptional

True limits each SKU's options to its most flexible commitment type. Default false: the calculator compares every applicable type.

Default: false

include_pricingbooleanOptional

Set false to skip the pricing computation (fast document read)

Default: true

include_optionsbooleanOptional

Set true to include the full per-line commitment_options grids (large). Default false: line items carry status, on-demand cost, and the re-matched selected option only — read one line's grid via GET .../line-items/{line_item_id} instead.

Default: false

Responses

200

OK

application/json

idstring · uuidRequired

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Possible values:

namestringRequired

descriptionstring · nullableRequired

source_draft_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

pricingany ofOptional

Computed pricing; null when include_pricing=false

or

object · nullableOptional

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

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/beta/v1/org/{org_id}/cost-estimates/{estimate_id}

GET /beta/v1/org/{org_id}/cost-estimates/{estimate_id} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "aws",
  "name": "text",
  "description": "text",
  "source_draft_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "line_items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "catalog_sku": {
        "catalog_sku_org_id": "text",
        "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "aws",
        "provider_sku_id": "text",
        "display_name": "text",
        "instance_type": "text",
        "service": "text",
        "provider_service": "text",
        "region_code": "text",
        "operating_system": "text",
        "database_engine": "text",
        "cache_engine": "text",
        "usage_type": "text"
      },
      "usage_unit": "text",
      "label": "text",
      "quantity": 1,
      "quantity_basis": "resource_count",
      "is_enabled": true,
      "selected_commitment_option": {
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "commitment_type": "text",
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer_org_id": "text",
        "offer_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pricing": {
    "line_items": [
      {
        "line_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "ok",
        "detail": "text",
        "ondemand_monthly_cost": 1,
        "matched_commitment_option": {
          "offer_id": "123e4567-e89b-12d3-a456-426614174000",
          "offer_org_id": "text",
          "offer": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "provider": "aws",
            "type": "text",
            "region": "text",
            "duration_seconds": 1,
            "instance_type": "text",
            "instance_family": "text",
            "offering_class": "standard",
            "payment_option": "no_upfront",
            "plan_type": "text",
            "product_description": "text",
            "display_name": "text",
            "guaranteed_display_name": "text",
            "is_flexible": true
          },
          "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
          "selected_amount": 1,
          "commitment_type": "text",
          "contract_term": "one_year_gris",
          "payment_option": "no_upfront",
          "discount_rate": 1,
          "breakeven_days": 1,
          "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
          }
        },
        "commitment_options": [
          {
            "offer_id": "123e4567-e89b-12d3-a456-426614174000",
            "offer_org_id": "text",
            "offer": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "provider": "aws",
              "type": "text",
              "region": "text",
              "duration_seconds": 1,
              "instance_type": "text",
              "instance_family": "text",
              "offering_class": "standard",
              "payment_option": "no_upfront",
              "plan_type": "text",
              "product_description": "text",
              "display_name": "text",
              "guaranteed_display_name": "text",
              "is_flexible": true
            },
            "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
            "selected_amount": 1,
            "commitment_type": "text",
            "contract_term": "one_year_gris",
            "payment_option": "no_upfront",
            "discount_rate": 1,
            "breakeven_days": 1,
            "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
            }
          }
        ]
      }
    ],
    "totals": {
      "ondemand_monthly_cost": 1,
      "estimated_monthly_cost": 1,
      "monthly_net_savings": 1,
      "commitment_upfront_cost": 1
    }
  }
}

Delete a cost estimate

delete

Soft-deletes the estimate: it disappears from list and detail reads, while plans generated from it and shares keep their provenance links. Its draft id (if any) is released for re-import.

Path parameters

org_idstring · uuidRequired

estimate_idstring · uuidRequired

Responses

204

No Content

No content

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

delete/beta/v1/org/{org_id}/cost-estimates/{estimate_id}

DELETE /beta/v1/org/{org_id}/cost-estimates/{estimate_id} HTTP/1.1
Accept: */*

No content

Update a cost estimate

patch

Merge-semantic update of name / description.

Path parameters

org_idstring · uuidRequired

estimate_idstring · uuidRequired

Body

namestring · min: 1 · max: 255Optional

descriptionstring · nullableOptional

Responses

200

OK

application/json

idstring · uuidRequired

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Possible values:

namestringRequired

descriptionstring · nullableRequired

source_draft_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

pricingany ofOptional

Computed pricing; null when include_pricing=false

or

object · nullableOptional

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

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

patch/beta/v1/org/{org_id}/cost-estimates/{estimate_id}

PATCH /beta/v1/org/{org_id}/cost-estimates/{estimate_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "aws",
  "name": "text",
  "description": "text",
  "source_draft_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "line_items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "catalog_sku": {
        "catalog_sku_org_id": "text",
        "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "aws",
        "provider_sku_id": "text",
        "display_name": "text",
        "instance_type": "text",
        "service": "text",
        "provider_service": "text",
        "region_code": "text",
        "operating_system": "text",
        "database_engine": "text",
        "cache_engine": "text",
        "usage_type": "text"
      },
      "usage_unit": "text",
      "label": "text",
      "quantity": 1,
      "quantity_basis": "resource_count",
      "is_enabled": true,
      "selected_commitment_option": {
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "commitment_type": "text",
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer_org_id": "text",
        "offer_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pricing": {
    "line_items": [
      {
        "line_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "ok",
        "detail": "text",
        "ondemand_monthly_cost": 1,
        "matched_commitment_option": {
          "offer_id": "123e4567-e89b-12d3-a456-426614174000",
          "offer_org_id": "text",
          "offer": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "provider": "aws",
            "type": "text",
            "region": "text",
            "duration_seconds": 1,
            "instance_type": "text",
            "instance_family": "text",
            "offering_class": "standard",
            "payment_option": "no_upfront",
            "plan_type": "text",
            "product_description": "text",
            "display_name": "text",
            "guaranteed_display_name": "text",
            "is_flexible": true
          },
          "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
          "selected_amount": 1,
          "commitment_type": "text",
          "contract_term": "one_year_gris",
          "payment_option": "no_upfront",
          "discount_rate": 1,
          "breakeven_days": 1,
          "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
          }
        },
        "commitment_options": [
          {
            "offer_id": "123e4567-e89b-12d3-a456-426614174000",
            "offer_org_id": "text",
            "offer": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "provider": "aws",
              "type": "text",
              "region": "text",
              "duration_seconds": 1,
              "instance_type": "text",
              "instance_family": "text",
              "offering_class": "standard",
              "payment_option": "no_upfront",
              "plan_type": "text",
              "product_description": "text",
              "display_name": "text",
              "guaranteed_display_name": "text",
              "is_flexible": true
            },
            "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
            "selected_amount": 1,
            "commitment_type": "text",
            "contract_term": "one_year_gris",
            "payment_option": "no_upfront",
            "discount_rate": 1,
            "breakeven_days": 1,
            "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
            }
          }
        ]
      }
    ],
    "totals": {
      "ondemand_monthly_cost": 1,
      "estimated_monthly_cost": 1,
      "monthly_net_savings": 1,
      "commitment_upfront_cost": 1
    }
  }
}

Add line items to a cost estimate

post

Bulk-adds lines. Catalog refs are resolved against the public catalog plus the org's custom-priced SKUs and must match the estimate's provider; descriptor fields are snapshotted server-side. Duplicate SKUs across line items are allowed — that is how partial coverage is expressed (e.g. 3 committed + 2 on-demand of the same SKU as two line items).

Path parameters

org_idstring · uuidRequired

estimate_idstring · uuidRequired

Body

Responses

200

OK

application/json

idstring · uuidRequired

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Possible values:

namestringRequired

descriptionstring · nullableRequired

source_draft_idstring · uuid · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

pricingany ofOptional

Computed pricing; null when include_pricing=false

or

object · nullableOptional

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

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

post/beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items

POST /beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 432

{
  "line_items": [
    {
      "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
      "catalog_sku_org_id": "text",
      "quantity": 1,
      "quantity_basis": "resource_count",
      "label": "text",
      "is_enabled": true,
      "selected_commitment_option": {
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "commitment_type": "text",
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer_org_id": "text",
        "offer_id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "aws",
  "name": "text",
  "description": "text",
  "source_draft_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "line_items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "catalog_sku": {
        "catalog_sku_org_id": "text",
        "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "aws",
        "provider_sku_id": "text",
        "display_name": "text",
        "instance_type": "text",
        "service": "text",
        "provider_service": "text",
        "region_code": "text",
        "operating_system": "text",
        "database_engine": "text",
        "cache_engine": "text",
        "usage_type": "text"
      },
      "usage_unit": "text",
      "label": "text",
      "quantity": 1,
      "quantity_basis": "resource_count",
      "is_enabled": true,
      "selected_commitment_option": {
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "commitment_type": "text",
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer_org_id": "text",
        "offer_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pricing": {
    "line_items": [
      {
        "line_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "ok",
        "detail": "text",
        "ondemand_monthly_cost": 1,
        "matched_commitment_option": {
          "offer_id": "123e4567-e89b-12d3-a456-426614174000",
          "offer_org_id": "text",
          "offer": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "provider": "aws",
            "type": "text",
            "region": "text",
            "duration_seconds": 1,
            "instance_type": "text",
            "instance_family": "text",
            "offering_class": "standard",
            "payment_option": "no_upfront",
            "plan_type": "text",
            "product_description": "text",
            "display_name": "text",
            "guaranteed_display_name": "text",
            "is_flexible": true
          },
          "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
          "selected_amount": 1,
          "commitment_type": "text",
          "contract_term": "one_year_gris",
          "payment_option": "no_upfront",
          "discount_rate": 1,
          "breakeven_days": 1,
          "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
          }
        },
        "commitment_options": [
          {
            "offer_id": "123e4567-e89b-12d3-a456-426614174000",
            "offer_org_id": "text",
            "offer": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "provider": "aws",
              "type": "text",
              "region": "text",
              "duration_seconds": 1,
              "instance_type": "text",
              "instance_family": "text",
              "offering_class": "standard",
              "payment_option": "no_upfront",
              "plan_type": "text",
              "product_description": "text",
              "display_name": "text",
              "guaranteed_display_name": "text",
              "is_flexible": true
            },
            "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
            "selected_amount": 1,
            "commitment_type": "text",
            "contract_term": "one_year_gris",
            "payment_option": "no_upfront",
            "discount_rate": 1,
            "breakeven_days": 1,
            "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
            }
          }
        ]
      }
    ],
    "totals": {
      "ondemand_monthly_cost": 1,
      "estimated_monthly_cost": 1,
      "monthly_net_savings": 1,
      "commitment_upfront_cost": 1
    }
  }
}

Get one line item's computed pricing

get

Returns a persisted line item together with its freshly computed full commitment option grid — the drill-in read for choosing an option. line_item carries the quantity and persisted selection descriptor; pricing carries on-demand monthly cost, options at that quantity, and the re-matched selected option. Pricing is line-local — a line item's cost never depends on sibling line items (usage tiers apply within a line item, matching how the estimate totals are built).

Path parameters

org_idstring · uuidRequired

estimate_idstring · uuidRequired

line_item_idstring · uuidRequired

Query parameters

only_most_flexible_commitment_typebooleanOptional

True limits each SKU's options to its most flexible commitment type. Default false: the calculator compares every applicable type.

Default: false

Responses

200

OK

application/json

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

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items/{line_item_id}

GET /beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items/{line_item_id} HTTP/1.1
Accept: */*

{
  "line_item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "catalog_sku": {
      "catalog_sku_org_id": "text",
      "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
      "provider": "aws",
      "provider_sku_id": "text",
      "display_name": "text",
      "instance_type": "text",
      "service": "text",
      "provider_service": "text",
      "region_code": "text",
      "operating_system": "text",
      "database_engine": "text",
      "cache_engine": "text",
      "usage_type": "text"
    },
    "usage_unit": "text",
    "label": "text",
    "quantity": 1,
    "quantity_basis": "resource_count",
    "is_enabled": true,
    "selected_commitment_option": {
      "contract_term": "one_year_gris",
      "payment_option": "no_upfront",
      "commitment_type": "text",
      "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
      "offer_org_id": "text",
      "offer_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  },
  "pricing": {
    "line_item_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "ok",
    "detail": "text",
    "ondemand_monthly_cost": 1,
    "matched_commitment_option": {
      "offer_id": "123e4567-e89b-12d3-a456-426614174000",
      "offer_org_id": "text",
      "offer": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "provider": "aws",
        "type": "text",
        "region": "text",
        "duration_seconds": 1,
        "instance_type": "text",
        "instance_family": "text",
        "offering_class": "standard",
        "payment_option": "no_upfront",
        "plan_type": "text",
        "product_description": "text",
        "display_name": "text",
        "guaranteed_display_name": "text",
        "is_flexible": true
      },
      "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
      "selected_amount": 1,
      "commitment_type": "text",
      "contract_term": "one_year_gris",
      "payment_option": "no_upfront",
      "discount_rate": 1,
      "breakeven_days": 1,
      "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
      }
    },
    "commitment_options": [
      {
        "offer_id": "123e4567-e89b-12d3-a456-426614174000",
        "offer_org_id": "text",
        "offer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "provider": "aws",
          "type": "text",
          "region": "text",
          "duration_seconds": 1,
          "instance_type": "text",
          "instance_family": "text",
          "offering_class": "standard",
          "payment_option": "no_upfront",
          "plan_type": "text",
          "product_description": "text",
          "display_name": "text",
          "guaranteed_display_name": "text",
          "is_flexible": true
        },
        "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
        "selected_amount": 1,
        "commitment_type": "text",
        "contract_term": "one_year_gris",
        "payment_option": "no_upfront",
        "discount_rate": 1,
        "breakeven_days": 1,
        "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
        }
      }
    ]
  }
}

Remove a line item

delete

Removes the line from the estimate.

Path parameters

org_idstring · uuidRequired

estimate_idstring · uuidRequired

line_item_idstring · uuidRequired

Responses

204

No Content

No content

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

delete/beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items/{line_item_id}

DELETE /beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items/{line_item_id} HTTP/1.1
Accept: */*

No content

Update a line item

patch

Merge-semantic update of quantity, quantity_basis, label, is_enabled, and the selected commitment option. Changing quantity_basis reinterprets the number, so it requires quantity in the same request. Pass selected_commitment_option: null to revert the line to on-demand. To choose an option, copy from a commitment_options entry: commitment_type, contract_term, payment_option, lease_menu_item_id, offer_id, and offer_org_id.

Path parameters

org_idstring · uuidRequired

estimate_idstring · uuidRequired

line_item_idstring · uuidRequired

Body

quantitynumber · min: 0Optional

quantity_basisstring · enumOptionalPossible values:

labelstring · max: 255 · nullableOptional

is_enabledbooleanOptional

False keeps the line item in the basket (still priced per line) but excludes it from totals and plan generation (what-if toggle).

selected_commitment_optionany ofOptional

object · nullableOptional

or

Responses

200

OK

application/json

idstring · uuidRequired

usage_unitstring · nullableOptional

labelstring · nullableOptional

quantitynumberRequired

quantity_basisstring · enumRequiredPossible values:

is_enabledbooleanRequired

False = kept in the basket but excluded from totals and plans

selected_commitment_optionany ofRequired

Persisted selected commitment option, or null for on-demand

or

object · nullableOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

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

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

patch/beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items/{line_item_id}

PATCH /beta/v1/org/{org_id}/cost-estimates/{estimate_id}/line-items/{line_item_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "quantity": 1,
  "quantity_basis": "resource_count",
  "label": "text",
  "is_enabled": true,
  "selected_commitment_option": {}
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "catalog_sku": {
    "catalog_sku_org_id": "text",
    "catalog_sku_id": "123e4567-e89b-12d3-a456-426614174000",
    "provider": "aws",
    "provider_sku_id": "text",
    "display_name": "text",
    "instance_type": "text",
    "service": "text",
    "provider_service": "text",
    "region_code": "text",
    "operating_system": "text",
    "database_engine": "text",
    "cache_engine": "text",
    "usage_type": "text"
  },
  "usage_unit": "text",
  "label": "text",
  "quantity": 1,
  "quantity_basis": "resource_count",
  "is_enabled": true,
  "selected_commitment_option": {
    "contract_term": "one_year_gris",
    "payment_option": "no_upfront",
    "commitment_type": "text",
    "lease_menu_item_id": "123e4567-e89b-12d3-a456-426614174000",
    "offer_org_id": "text",
    "offer_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}