checkout_rates

List checkout rates configurations

Changed on

Return a summary of every checkout rates configuration on your account. Each entry contains identifying fields only; use Get a checkout rates configuration to retrieve an individual configuration's options and shared settings.

get/v1/checkout_rates

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/checkout_rates
  • Auth: API key in header API-Key

Response

The list of checkout rates configurations.

config_idstring

The unique identifier of the configuration.

is_activeboolean

Whether the configuration is active.

created_atstring date-time

When the configuration was created.

Example response

[
  {
    "config_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "is_active": true,
    "created_at": "2026-05-15T18:30:00Z"
  }
]

Changes

  • e998dffc42beRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

  • 020f57d6f5b8Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status