Skip to main content
GET
Listar Cobranças Agendadas

Visão Geral

Retorna uma lista paginada das cobranças agendadas do seller autenticado. Use os filtros para construir as abas do dashboard (Próximas / Vencidas / Pausadas / Concluídas).

Exemplo de Requisição

Parâmetros de Query

string | string[]
Filtra por status. Pode ser repetido (?status=scheduled&status=due_today). Valores: scheduled, due_today, overdue, paid, paused, canceled, trial, pending_tokenization, recurrence_canceled.
number
Restringe a um cliente específico.
string
Filtra por tipo. Hoje só existem cobranças one_time.
string
Limite inferior de dueDate (YYYY-MM-DD).
string
Limite superior de dueDate (YYYY-MM-DD).
Busca livre no nome / e-mail / CPF do cliente vinculado à cobrança.
number
default:"1"
Página da paginação.
number
default:"20"
Itens por página (máx. 100).

Resposta

Os campos customer e product vêm carregados (com os dados essenciais para listagem) para evitar uma segunda chamada por cobrança.