ABabacatepay

Listar checkouts de assinatura

Changed on

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.

get/subscriptions/checkouts/list

Request

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

Query parameters

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger
Example:100

Quantidade de itens por página (1-100).

startDatestring date
Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date
Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring
Example:bill_abc123xyz

Filtrar por identificador único do checkout

externalIdstring
Example:assinatura-123

Filtrar por identificador do checkout no seu sistema

status'PENDING' | 'EXPIRED' | 'CANCELLED' | 'PAID' | 'REFUNDED'

Filtrar por status do checkout

keywordstring

Busca textual livre

customerIdstring
Example:cust_abc123xyz

Filtrar pelo identificador do cliente associado

method'PIX' | 'CARD'

Filtrar por método de pagamento. Traz todo checkout que oferece este método, mesmo que ofereça outros também.

Response

Checkouts de assinatura listados com sucesso.

successboolean

Se a requisição obteve sucesso ou não.

errorstring nullable

Example response

{
  "data": [
    {
      "id": "bill_abc123xyz",
      "externalId": "pedido-123",
      "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
      "amount": 10000,
      "items": [
        {
          "id": "prod_456",
          "quantity": 2
        }
      ],
      "status": "PENDING",
      "coupons": [],
      "upSellProductId": "prod_bump456xyz",
      "installmentsCount": 3,
      "card": {
        "maxInstallments": 12
      },
      "dueDate": "2026-08-15",
      "interest": {
        "value": 100
      },
      "fine": {
        "value": 200,
        "type": "PERCENTAGE"
      },
      "metadata": {},
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true
}

Changes

  • 319122d4f5fcRevision changes
    • warning

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

    • info

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

    • info

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

  • f72547ee8530Revision changes
    • info

      endpoint added