> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/v1/checkouts/

> Retorna uma lista paginada de sessões de checkout

Lista todas as sessões de checkout da organização com suporte a paginação e filtros.

## Autenticação

Requer **Organization Access Token (OAT)** via header `Authorization: Bearer`.

## Parâmetros de Query

**organization\_id** `string[]`

Filtrar por ID da organização (pode ser repetido para múltiplos valores)

**product\_id** `string[]`

Filtrar por ID do produto

**customer\_id** `string[]`

Filtrar por ID do cliente

**status** `string[]`

Filtrar por status do checkout. Valores: `open`, `confirmed`, `succeeded`, `expired`, `failed`

**query** `string`

Busca por e-mail do cliente

**page** `integer` (default: 1)

Número da página

**limit** `integer` (default: 20)

Itens por página

**sorting** `string[]` (default: -created\_at)

Ordenação. Use `-` para decrescente. Ex: `-created_at`, `created_at`

## Resposta

**items** `array`

Lista de objetos de checkout

**pagination** `object`

**Propriedades**

**total\_count** `integer`

Número total de itens

**max\_page** `integer`

Número máximo de páginas

## Exemplo

```bash cURL theme={null}
curl -X GET "https://api.chargefy.io/api/v1/checkouts/?page=1&limit=10&status=open" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

const checkouts = await chargefy.checkouts.list({
  page: 1,
  limit: 10,
  status: 'open',
});
```

## Resposta de Exemplo

```json theme={null}
{
  "items": [
    {
      "id": "chk_1a2b3c4d5e6f",
      "status": "open",
      "product_price_id": "pp_abc123",
      "customer_email": "cliente@exemplo.com",
      "amount": 9900,
      "currency": "BRL",
      "success_url": "https://meusite.com/sucesso",
      "client_secret": "chk_secret_xyz789",
      "metadata": {},
      "created_at": "2026-03-12T10:00:00Z",
      "updated_at": "2026-03-12T10:00:00Z",
      "expires_at": "2026-03-12T10:30:00Z"
    }
  ],
  "pagination": {
    "total_count": 42,
    "max_page": 5
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.