---
title: "Read checkout"
description: "Reads one of the customer's checkouts."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Read checkout

Needs the read scope.

## Call

- Tool: `get_checkout`
- Scope: `read`
- Reads only.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `checkout` | `object` | Yes |  |

```json
{
  "type": "object",
  "properties": {
    "checkout": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "checkout"
  ],
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `string` | Yes |  |
| `order` | `object or null` | Yes |  |
| `under_minimum` | `object or null` | Yes |  |
| `refund_consent` | `string or null` | Yes |  |
| `card_required` | `object or null` | Yes |  |
| `items` | `array of object` | Yes |  |
| `totals` | `object` | Yes |  |
| `id` | `string` | Yes |  |
| `currency` | `string` | Yes |  |
| `exponent` | `number or null` | Yes |  |
| `coupon` | `string or null` | Yes |  |
| `refund_waiver` | `object or null` | Yes |  |
| `expires_at` | `string or null` | Yes |  |
| `created_at` | `string or null` | Yes |  |
| `updated_at` | `string or null` | Yes |  |

The answer's full shape is on [its API reference page](/customer-api/reference/get-checkout).

Source: https://docs.sherpo.io/customer-mcp/tools/get_checkout/index.mdx
