Listar assinaturas
Lista as assinaturas da loja, com paginação e filtros por e-mail, status e intervalo de próxima cobrança. Retorna 10 itens por página.
Informe pelo menos um entre email, next_charge_from e
next_charge_to. Os filtros são combináveis: email sozinho devolve as
assinaturas daquele cliente, o intervalo sozinho devolve as da loja inteira
que cobram no período, e juntos devolvem as daquele cliente no período.
As duas pontas do intervalo são opcionais entre si: só next_charge_to
lista o que vai cobrar de agora até aquela data.
Formato de data na listagem
Nesta rota next_charge_at e charges[].charged_at vêm no formato
dd/mm/aaaa. No detalhe da assinatura, next_charge_at vem como
aaaa-mm-dd hh:mm:ss. Já os filtros next_charge_from e next_charge_to
são informados como aaaa-mm-dd.
Autorizações
Token Bearer do merchant obtido via POST /oauth2/token usando as
credenciais do merchant (não do app). Veja
Autenticação.
Parâmetros
Parâmetros de Consulta
E-mail do cliente. Obrigatório quando nem next_charge_from nem
next_charge_to forem informados.
Data inicial da próxima cobrança, no formato aaaa-mm-dd e no fuso de
Brasília. Considera o dia inteiro. Pode ser usada sozinha, para listar
tudo que cobra a partir daquele dia. Quando omitida e next_charge_to
for informada, o início passa a ser o momento atual — ou seja, a
listagem traz o que ainda vai cobrar daqui até a data final.
"2026-09-18""date"Data final da próxima cobrança, no formato aaaa-mm-dd e no fuso de
Brasília. Considera o dia inteiro, então informar a mesma data em
next_charge_from e next_charge_to lista as cobranças daquele dia.
Deve ser maior ou igual a next_charge_from. Sozinha, lista o que vai
cobrar do momento atual até essa data.
"2026-09-18""date"Filtra pelo status da assinatura. Aceita ACTIVE, PAUSED, CANCELLED
e OVERDUE. Sem filtro, a listagem devolve todos os status, incluindo
SUSPENDED e FINISHED — veja status no item da listagem.
Ao usar o intervalo de próxima cobrança sem informar status, a listagem
traz apenas o que de fato será cobrado no período: assinaturas ACTIVE
não pausadas e OVERDUE. Informando status, ele prevalece e o intervalo
apenas recorta aquele status.
"ACTIVE""PAUSED""CANCELLED""OVERDUE""ACTIVE"Página da listagem.
111Respostas
Lista de assinaturas retornada com sucesso.