ABabacatepay

Listar assinaturas

Changed on

Retorna as assinaturas (subs_...) da sua loja, com paginação por cursor.

A assinatura só existe depois que o cliente paga o checkout de assinatura. Para listar os checkouts de assinatura (bill_...), inclusive os que ainda não foram pagos, use GET /subscriptions/checkouts/list.

Cada assinatura traz o checkoutId do checkout que a originou. Um mesmo checkout pode gerar várias assinaturas, uma por cliente que o pagou; use o filtro checkoutId para encontrá-las.

get/subscriptions/list

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/subscriptions/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).

status'ACTIVE' | 'CANCELLED'

Filtrar por status da assinatura

checkoutIdstring
Example:bill_abc123xyz

Filtrar pelo checkout de assinatura que originou a assinatura. Um checkout inexistente retorna lista vazia.

Response

Lista de assinaturas retornada com sucesso.

successboolean

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

errorstring nullable

Example response

{
  "data": [
    {
      "id": "subs_abc123xyz",
      "checkoutId": "bill_abc123xyz",
      "customerId": "cust_abc123xyz",
      "amount": 10000,
      "status": "ACTIVE",
      "method": "CARD",
      "coupons": [],
      "retryPolicy": {
        "maxRetry": 3,
        "retryEvery": 1
      },
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true
}

Changes

  • f72547ee8530Revision changes
    • breaking

      removed the enum value EXPIRED from the query request parameter status

    • breaking

      removed the enum value PAID from the query request parameter status

    • breaking

      removed the enum value PENDING from the query request parameter status

    • breaking

      removed the enum value REFUNDED from the query request parameter status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

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

    • info

      added the new optional query request parameter checkoutId

    • info

      added the new enum value ACTIVE to the query request parameter status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      removed the EXPIRED enum value from the // response property for the response status

    • info

      removed the PAID enum value from the // response property for the response status

    • info

      removed the REFUNDED enum value from the // response property for the response status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • ea8a72b04f2aRevision changes
    • warning

      deleted the query request parameter email

    • warning

      deleted the query request parameter externalId

    • warning

      deleted the query request parameter id

    • warning

      deleted the query request parameter taxId