---
title: "Get a quote"
description: "Read back a saved quote by its quoteId: the plans it offered, their prices and the coverage text."
---

`GET https://{HOST_NAME}/quote/api/quote/{quoteId}`

Use this endpoint to look up a quote you received earlier, for example to show the plan a customer chose, or to check a `quoteId` and `quoteItemId` before you record an order. The quote must have been saved: send `quoteSyncMode=SYNC` on the quoting call, or wait for the asynchronous save to complete.

## Headers

No authentication header is needed for this endpoint.

## Path parameters

<ParamField path="quoteId" type="string" required>
  The `quoteId` returned by a quoting endpoint.
</ParamField>

## Example request

```bash
curl 'https://{HOST_NAME}/quote/api/quote/4d2a9e7c-1b3f-4a6d-9c8e-2f1a3b4c5d6e'
```

## Response

<ResponseField name="isError" type="boolean">
  `false` on success.
</ResponseField>
<ResponseField name="quoteDetails" type="object">
  <Expandable title="fields">
    <ResponseField name="quoteId" type="string">
      The quote identifier.
    </ResponseField>
    <ResponseField name="storeName" type="string">
      The store the quote was made for.
    </ResponseField>
    <ResponseField name="platform" type="string">
      The platform the quote was requested from.
    </ResponseField>
    <ResponseField name="storeCategoryId" type="string">
      The store category the quote was priced against.
    </ResponseField>
    <ResponseField name="sbProductId" type="string">
      Your product reference, when the quote was made for a specific product.
    </ResponseField>
    <ResponseField name="country" type="string">
      Country the quote was priced in.
    </ResponseField>
    <ResponseField name="province" type="string">
      State or province, when it affected the price.
    </ResponseField>
    <ResponseField name="visitId" type="string">
      The visit the quote was made in.
    </ResponseField>
    <ResponseField name="createdAt" type="string">
      When the quote was created.
    </ResponseField>
    <ResponseField name="updatedAt" type="string">
      When the quote was last updated.
    </ResponseField>
    <ResponseField name="quoteItemList" type="object[]">
      One entry per plan offered.
      <Expandable title="fields">
        <ResponseField name="quoteItemId" type="string">
          Plan identifier to send when recording an order.
        </ResponseField>
        <ResponseField name="policyPrice" type="number">
          Plan price.
        </ResponseField>
        <ResponseField name="coverageYears" type="number">
          Plan term in years.
        </ResponseField>
        <ResponseField name="lowerPrice" type="number">
          Lower bound of the product price band the plan applies to.
        </ResponseField>
        <ResponseField name="upperPrice" type="number">
          Upper bound of that price band.
        </ResponseField>
        <ResponseField name="storeProductVariantPrice" type="number">
          The product price the plan was priced on.
        </ResponseField>
        <ResponseField name="country" type="string">
          Country of the plan.
        </ResponseField>
        <ResponseField name="province" type="string">
          State or province of the plan, when set.
        </ResponseField>
        <ResponseField name="isDefault" type="boolean">
          Whether the widget preselects this plan.
        </ResponseField>
        <ResponseField name="isRibbon" type="boolean">
          Whether the widget shows a ribbon on this plan.
        </ResponseField>
        <ResponseField name="ribbonText" type="string">
          The ribbon label.
        </ResponseField>
        <ResponseField name="isActive" type="boolean">
          Whether the plan is still offered.
        </ResponseField>
      </Expandable>
    </ResponseField>
    <ResponseField name="coverageList" type="object[]">
      The coverage bullets of the category: `info`, `popup`, `optionType`, `iconType`.
    </ResponseField>
    <ResponseField name="policyId" type="string">
      Opaque reference to the plan's terms. Build the terms link from it as the widget does.
    </ResponseField>
    <ResponseField name="tncDocumentUrl" type="string">
      Direct link to the terms document, when one is published for the category.
    </ResponseField>
  </Expandable>
</ResponseField>

## Errors

| Code | Body | Meaning |
|------|------|---------|
| `500` | `{"isError": true, "message": "Internal Server Error"}` | No quote with this `quoteId` (not saved yet, or unknown), or an unexpected failure |

There is no `404`; treat `500` on a known id as "not saved yet" and retry after the quoting call completes.
