Skip to main content
GET
/
subscriptions
/
list
Listar assinaturas (Checkouts de assinatura)
curl --request GET \
  --url https://api.abacatepay.com/v2/subscriptions/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "bill_abc123xyz",
      "externalId": "pedido-123",
      "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
      "amount": 10000,
      "paidAmount": null,
      "items": [
        {
          "id": "prod_456",
          "quantity": 2
        }
      ],
      "status": "PENDING",
      "coupons": [],
      "devMode": false,
      "customerId": null,
      "returnUrl": null,
      "completionUrl": null,
      "receiptUrl": null,
      "metadata": {},
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true,
  "error": null,
  "pagination": {
    "hasMore": true,
    "next": "<string>",
    "before": "<string>"
  }
}
Lista os checkouts de assinatura. Cada item em data tem o mesmo formato do Checkout (id, url, amount, items, status, etc.). Pagine com limit, after e before.

Authorizations

​
Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

​
after
string

Cursor para buscar itens após este ponto

​
before
string

Cursor para buscar itens antes deste ponto

​
limit
integer
default:100

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

Required range: 1 <= x <= 100
Example:

100

​
id
string

Filtrar por identificador único do Checkout de assinatura

Example:

"bill_abc123xyz"

​
externalId
string

Filtrar por identificador da assinatura no seu sistema

Example:

"subs-123"

​
status
enum<string>

Filtrar por status do Checkout de assinatura

Available options:
PENDING,
EXPIRED,
CANCELLED,
PAID,
REFUNDED
​
email
string

Filtrar por e-mail do cliente associado

Example:

"daniel_lima@abacatepay.com"

​
taxId
string

Filtrar por CPF ou CNPJ do cliente associado

Example:

"123.456.789-01"

Response

Lista de Checkouts de assinatura retornada com sucesso.

​
data
object[]

Lista de Checkouts de assinatura (mesmo payload de Checkout).

​
success
boolean

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

Example:

true

​
error
string | null
Example:

null

​
pagination
object

Informações de paginação baseada em cursor.