v2

OpenAPI 3.1.02026-07-314524165.2 KB

Listar assinaturas (Checkouts de assinatura)

Retorna todos os Checkouts de assinatura que você criou, com suporte a paginação baseada em cursor. Cada item possui o mesmo formato de um Checkout: id, url, amount, items, status, etc.

get/subscriptions/list

Query parameters

afterstring

Cursor para buscar itens após este ponto

beforestring

Cursor para buscar itens antes deste ponto

limitinteger

Example:100

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

idstring

Example:bill_abc123xyz

Filtrar por identificador único do Checkout de assinatura

externalIdstring

Example:subs-123

Filtrar por identificador da assinatura no seu sistema

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

Filtrar por status do Checkout de assinatura

emailstring

Example:daniel_lima@abacatepay.com

Filtrar por e-mail do cliente associado

taxIdstring

Example:123.456.789-01

Filtrar por CPF ou CNPJ do cliente associado

Response

Lista de Checkouts de assinatura retornada 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,
      "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
}