---
title: "Listar checkouts de assinatura"
method: GET
path: "/subscriptions/checkouts/list"
---

# Listar checkouts de assinatura

`GET /subscriptions/checkouts/list`

## Request

- Base URL: `https://api.abacatepay.com/v2`
- URL: `https://api.abacatepay.com/v2/subscriptions/checkouts/list`
- Auth: HTTP bearer

Retorna os checkouts de assinatura (`bill_...` com `frequency: SUBSCRIPTION`) da sua loja, pagos ou não, com paginação por cursor. O formato de cada item é o mesmo do `GET /checkouts/list`.

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `startDate` string, date
- `endDate` string, date
- `id` string
- `externalId` string
- `status` 'PENDING' | 'EXPIRED' | 'CANCELLED' | 'PAID' | 'REFUNDED'
- `keyword` string
- `customerId` string
- `method` 'PIX' | 'CARD'

## Response `200`

Checkouts de assinatura listados com sucesso.

- object
  - `data` Billing[]: Lista de checkouts de assinatura.
    - `id` string: Identificador único do Checkout.
    - `externalId` string, nullable: ID do Checkout no seu sistema.
    - `url` string, uri: URL onde o usuário pode concluir o pagamento.
    - `amount` number: Valor total a ser pago em centavos.
    - `paidAmount` number, nullable: Valor já pago em centavos. Null se ainda não foi pago.
    - `items` object[]: Lista de itens no Checkout.
      - `id` string: ID do produto.
      - `quantity` integer: Quantidade do item.
    - `status` 'PENDING' | 'EXPIRED' | 'CANCELLED' | 'PAID' | 'REFUNDED' | 'REDEEMED': Status atual do Checkout. `REDEEMED` quando o cliente fechou o checkout com um cupom de 100%, sem pagar nada.
    - `coupons` string[]: Lista de cupons aplicados no Checkout.
    - `devMode` boolean: Indica se a cobrança foi criada em ambiente de testes.
    - `customerId` string, nullable: ID do cliente associado ao Checkout.
    - `returnUrl` string, uri, nullable: URL para onde o cliente será redirecionado ao clicar em "Voltar".
    - `completionUrl` string, uri, nullable: URL para onde o cliente será redirecionado após o pagamento.
    - `receiptUrl` string, uri, nullable: URL do comprovante de pagamento.
    - `upSellProductId` string, nullable: ID do produto de upsell vinculado ao Checkout. Null se nenhum produto de upsell foi informado na criação.
    - `installmentsCount` integer, nullable: Número de parcelas do pagamento quando realizado via Cartão de crédito com mais de uma parcela. `null` para pagamentos à vista ou realizados por outros métodos (PIX, Boleto).
    - `card` object: Configuração do pagamento por cartão enviada na criação.
      - `maxInstallments` integer: Número máximo de parcelas oferecidas no checkout.
      - `passFeesToCustomer` boolean: Se a taxa do cartão é repassada ao cliente.
    - `customerFee` integer, nullable: Acréscimo, em centavos, que o cliente pagou com o repasse da taxa do cartão (`card.passFeesToCustomer`). `null` sem repasse ou quando o pagamento não foi no cartão.
    - `dueDate` string, date, nullable: Data de vencimento do boleto (`YYYY-MM-DD`). `null` quando não foi configurada ou quando o método de pagamento não é BOLETO.
    - `interest` BoletoInterest: Juros por atraso aplicados ao boleto após o vencimento. Late interest applied to the boleto after the due date. Aplica-se apenas a `method: "BOLETO"`; ignorado nos demais métodos.
      - `value` integer, required: Percentual de juros ao mês em centésimos de percentual (`100` = 1% ao mês, `250` = 2,5% ao mês). Quando `0` ou omitido, sem juros. Calculado pro rata die após o vencimento. EN: Monthly late-interest rate in hundredths of a percent (`100` = 1%/month). Accrues pro rata die after the due date; `0` or omitted disables interest.
    - `fine` BoletoFine: Multa por atraso aplicada uma única vez após o vencimento do boleto. One-time late fine applied after the due date. Aplica-se apenas a `method: "BOLETO"`; ignorado nos demais métodos.
      - `value` integer, required: Quando `type = "PERCENTAGE"`: centésimos de percentual sobre o valor do boleto (`200` = 2%). Quando `type = "FIXED"`: valor fixo em centavos (`1000` = R$ 10,00). Quando `0` ou omitido, sem multa. EN: With `type: "PERCENTAGE"`, value is in hundredths of a percent (`200` = 2%). With `type: "FIXED"`, value is in cents (`1000` = R$ 10.00). `0` or omitted disables the fine.
      - `type` 'PERCENTAGE' | 'FIXED', required: Tipo da multa. `PERCENTAGE` aplica percentual sobre o valor do boleto; `FIXED` aplica um valor fixo em centavos. EN: Fine type. `PERCENTAGE` applies a percent of the boleto amount; `FIXED` applies a fixed amount in cents.
    - `metadata` object: Metadados adicionais do Checkout.
    - `createdAt` string, date-time: Data e hora de criação do Checkout.
    - `updatedAt` string, date-time: Data e hora da última atualização do Checkout.
  - `success` boolean: Se a requisição obteve sucesso ou não.
  - `error` string, nullable
  - `pagination` PaginationCursor: Informações de paginação baseada em cursor.
    - `hasMore` boolean, required: Indica se existe uma próxima página.
    - `next` string, nullable, required: Cursor da próxima página (usar em `after`). `null` na última página.
    - `before` string, nullable, required: Cursor da página anterior (usar em `before`). `null` na primeira página.

## Other responses

- `401`: Falha na autenticação.

## Changes

- **2026-10-20** `319122d4f5fc`: 1 warning, 2 info
  - added the new `REDEEMED` enum value to the `data/items/status` response property for the response status `200`
  - added the optional property `data/items/card` to the response with the `200` status
  - added the optional property `data/items/customerFee` to the response with the `200` status
- **2026-09-24** `f72547ee8530`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/abacatepay/apis/api-abacatepay/changes/subscriptions/checkouts/list/get.md)

---

[API](https://skmtc.dev/abacatepay/apis/api-abacatepay.md) - [All operations](https://skmtc.dev/abacatepay/apis/api-abacatepay/llms.txt) - [OpenAPI document](https://skmtc.dev/abacatepay/apis/api-abacatepay/revisions/8be803988b57?raw)