---
title: "Get a checkout rates configuration"
method: GET
path: "/v2/checkout_rates/{config_id}"
tags: ["checkout_rates"]
---

# Get a checkout rates configuration

`GET /v2/checkout_rates/{config_id}`

<aside class="access" aria-label="Endpoint access">
      <table class="access__table">
        <thead>
          <tr>
            <th class="access__table-header">Products</th>
            <th class="access__table-header">Plans</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td class="access__table-cell access__product">
              <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/>
              <div class="access__sub">Formerly ShipEngine</div>
            </td>
            <td class="access__table-cell access__plans">
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a>
            </td>
          </tr>
          <tr>
            <td class="access__table-cell">
              <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/>
            </td>
            <td class="access__table-cell access__plans">
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a>
              <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a>
            </td>
          </tr>
        </tbody>
      </table>
      <footer class="access__footer">
        <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md">
          Learn about products and plans
          <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/>
        </a>
      </footer>
    </aside>

Retrieve a single checkout rates configuration, including all of its delivery options and shared settings.

## Response `200`

The requested checkout rates configuration.

- CheckoutRatesConfigResponseBody — A checkout rates configuration with its delivery options and shared settings.
  - `config_id` string — The unique identifier of the configuration.
  - `options` CheckoutRatesOptionResponseBody[] — The delivery options in the configuration.
    - `option_id` integer — The unique identifier of the delivery option.
    - `config_id` string — The identifier of the configuration this option belongs to.
    - `name` string — The display name of the delivery option.
    - `type` 'live_rate' | 'flat_rate' | 'free' | 'local_delivery' — The kind of delivery option.
    - `services` CheckoutRatesServiceSelection[] — The carrier/service pairings rated by this option, when applicable.
      - `carrier_id` string, required — The ID of a carrier connected to your account, in the format `se-` followed by digits (for example, `se-1234567`). A value that does not match this format is rejected with a validation error, and a well-formed ID that is not connected to your account is rejected as an invalid identifier.
      - `service_code` string, required — The service code of the carrier service to rate (for example, `usps_priority_mail`). Required for each service; a service code that is not available for the carrier is rejected as an invalid identifier.
    - `fee_mode` 'add' | 'subtract' — Whether `fee_percentage` is added to or subtracted from the carrier rate.
    - `fee_percentage` number — The percentage of the carrier rate added or subtracted, according to `fee_mode`.
    - `sort_index` integer — The position of this option relative to the others in the configuration, ascending.
    - `fallback_mode` 'dont_show' | 'flat_rate' | 'cart_percentage' — What is shown when live rates cannot be retrieved.
    - `fallback_rate_amount` number — The fixed fallback price, when `fallback_mode` is `flat_rate`.
    - `fallback_rate_currency` string — The currency of `fallback_rate_amount`.
    - `fallback_percentage` number — The percentage of the cart total charged, when `fallback_mode` is `cart_percentage`.
    - `amount` number — The fixed price for a `flat_rate` option.
    - `currency` string — The currency of `amount`.
    - `is_active` boolean — Whether the option is active and shown at checkout.
    - `created_at` string, date-time — When the option was created.
  - `shared_settings` CheckoutRatesSharedSettings — Settings shared by every delivery option in a configuration, controlling how live rates are calculated.
    - `calculation_method` 'by_volume' | 'skip_dimensions' — How package dimensions are determined when calculating live rates. `by_volume` derives a package size from the cart; `skip_dimensions` rates without dimensions.
    - `dimensions_by_weight` CheckoutRatesDimensionsByWeight[] — Default package dimensions applied to carts by weight bound.
      - `max_weight` Weight — The weight of a package
        - `value` number, required — The weight, in the specified unit
        - `unit` 'pound' | 'ounce' | 'gram' | 'kilogram', required — The possible weight unit values
      - `default_dimensions` Dimensions — The dimensions of a package
        - `unit` 'inch' | 'centimeter', required — The dimension units that are supported by ShipStation .
        - `length` number, required — The length of the package, in the specified unit
        - `width` number, required — The width of the package, in the specified unit
        - `height` number, required — The height of the package, in the specified unit
  - `created_at` string, date-time — When the configuration was created.

## Other responses

- `404` — The specified resource does not exist.
- `500` — The request was successful.

---

[API](https://skmtc.net/shipstation/apis/shipstation-api-v2.md) · [All operations](https://skmtc.net/shipstation/apis/shipstation-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipstation/shipstation-api-v2/revisions/d3d8c21cd227/schema)