---
title: "Read a checkout session"
method: POST
path: "/api/agent/get_checkout"
tags: ["checkout"]
---

# Read a checkout session

`POST /api/agent/get_checkout`

## Request

- Base URL: `https://www.test-well.com`
- URL: `https://www.test-well.com/api/agent/get_checkout`
- Auth: none declared

Current state of a checkout session (status, line items, totals, messages, order once paid). Read-only.

## Request body

- object
  - `checkout_session_id` string, required

## Response `200`

Tool result

- object
  - `tool` 'get_checkout', required
  - `result` object, required
    - `id` string, required
    - `status` string, required
    - `line_items` object[], required
      - `id` string, required
      - `total` number, required
    - `totals` object[], required
      - `type` string, required
      - `display_text` string, required
      - `amount` number, required
    - `messages` object[], required
      - `type` 'info' | 'error', required
      - `content` string, required

## Other responses

- `400`: Invalid input
- `429`: Rate limited

---

[API](https://skmtc.dev/test-well/apis/testwell-agent-api.md) · [All operations](https://skmtc.dev/test-well/apis/testwell-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/test-well/apis/testwell-agent-api/revisions/6e260731dfa4?raw)