---
title: "Get a Cost Estimate"
method: GET
path: "/cost-estimates/{cost_estimate}"
tags: ["cost-estimates"]
---

# Get a Cost Estimate

`GET /cost-estimates/{cost_estimate}`

## Request

- Base URL: `https://example.scalr.io/api/iacp/v3`
- URL: `https://example.scalr.io/api/iacp/v3/cost-estimates/{cost_estimate}`
- Auth: HTTP bearer

Show details of a specific Cost Estimate phase.

## Path parameters

- `cost_estimate` string, required

## Response `200`

Success.

- CostEstimateDocument: JSON:API Document. see: https://jsonapi.org/format/#document-structure
  - `data` CostEstimate: A Cost Estimate is the details of the cost estimation phase of a `run` in Scalr. Cost estimation is optional and is enabled/disable per `environment`. If enabled a cost estimation is performed immediately after Terraform plan has completed for every run in every workspace, including dry runs.
    - `attributes` object
      - `delta-monthly-cost` string: The change in the estimated cost ($) from the previous run (if any).
      - `error-message` string, nullable: When the cost estimate status is `errored`, this field contains the error description.
      - `matched-resources-count` integer, nullable: The number of resources in the terraform plan, that were included into the estimation. Cost estimation in Scalr supports a number of terraform resources from major [cloud providers](https://docs.scalr.io/docs/cost-estimation)
      - `prior-monthly-cost` string: The estimated current monthly cost ($).
      - `proposed-monthly-cost` string: The estimated monthly cost ($) if the plan is applied.
      - `resources-count` integer, nullable: The total number of resources in the terraform plan.
      - `status` 'pending' | 'queued' | 'finished' | 'canceled' | 'errored' | 'unreachable': The Cost estimate's current status. Transient states: * `pending` - Cost estimation has been created but not yet `queued`. * `queued` - Queued and waiting for capacity to be available. Final states: * `canceled` - The cost estimate has been canceled. * `errored` - The cost estimate has finished with an error. Attribute `error-message` contains the details. * `finished` - The cost estimate has completed successfully. * `unreachable` - The cost estimate will not run.
      - `status-timestamps` object: Date/Time of transition to each status that has occurred.
      - `unmatched-resources-count` integer, nullable: The number of resources in the terraform plan that were excluded from the estimation.
    - `id` string
    - `links` object
      - `breakdown` string, nullable: Link to download the cost breakdown [JSON formatted output](https://www.infracost.io/docs/multi_project/report/#examples).
      - `output` string, nullable: Link to download the raw output of the cost estimation.
      - `self` string
    - `type` 'cost-estimates', required
  - `included` object[]
  - `meta` object

## Other responses

- `404`: Cost estimate not found or user unauthorized to perform action.
- `4XX`: Client error.
- `5XX`: Server error.

---

[API](https://skmtc.dev/scalr/apis/scalr-iacp-api.md) - [All operations](https://skmtc.dev/scalr/apis/scalr-iacp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scalr/apis/scalr-iacp-api/revisions/d3e1dc85657a?raw)