Skip to main content
GET
Listar assinaturas
Retorna as assinaturas (subs_...) da sua loja.
Requer a permissão SUBSCRIPTION:READ.
Use limit, after e before para paginar e startDate/endDate (YYYY-MM-DD) para filtrar por data de criação. Consulte Paginação e filtro por data.
Esta rota lista assinaturas, não checkouts. A assinatura só passa a existir 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 Listar checkouts de assinatura.

Encontrar as assinaturas de um checkout

Cada assinatura traz o checkoutId do checkout de assinatura que a originou. Um mesmo checkout pode gerar várias assinaturas, uma por cliente que o pagou. Para encontrá-las, filtre por checkoutId:
Um checkoutId que não existe retorna lista vazia.

Filtros

Valores de status:

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 (use o publicId retornado em pagination.next).

before
string

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

limit
integer
default:100

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

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

100

startDate
string<date>

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).

Example:

"2026-01-01"

endDate
string<date>

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).

Example:

"2026-01-31"

status
enum<string>

Filtrar por status da assinatura

Available options:
ACTIVE,
CANCELLED
checkoutId
string

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

Example:

"bill_abc123xyz"

Response

Lista de assinaturas retornada com sucesso.

data
object[]

Lista de assinaturas.

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.