Skip to main content
GET
/
api
/
scheduled-charges
Listar Cobranças Agendadas
curl --request GET \
  --url https://garu.com.br/api/scheduled-charges \
  --header 'Authorization: Bearer <token>'

​
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

# Próximas (scheduled + due_today)
curl -X GET "https://garu.com.br/api/scheduled-charges?status=scheduled&status=due_today" \
  -H "Authorization: Bearer sk_test_sua_chave"

# Em atraso de um cliente específico
curl -X GET "https://garu.com.br/api/scheduled-charges?status=overdue&customerId=42" \
  -H "Authorization: Bearer sk_test_sua_chave"

​
Parâmetros de Query

​
status
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.
​
customerId
number
Restringe a um cliente específico.
​
type
string
Filtra por tipo. Hoje só existem cobranças one_time.
​
dueFrom
string
Limite inferior de dueDate (YYYY-MM-DD).
​
dueTo
string
Limite superior de dueDate (YYYY-MM-DD).
​
search
string
Busca livre no nome / e-mail / CPF do cliente vinculado à cobrança.
​
page
number
default:"1"
Página da paginação.
​
limit
number
default:"20"
Itens por página (máx. 100).

​
Resposta

{
  "data": [
    {
      "id": "sch_abc123",
      "customerId": 42,
      "amount": 297.5,
      "dueDate": "2026-06-15",
      "methods": ["pix", "boleto"],
      "status": "scheduled",
      "customer": { "id": 42, "name": "Maria Silva", "email": "maria@exemplo.com.br", "document": "12345678901" },
      "product": null,
      "createdAt": "2026-05-01T12:00:00Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}
Os campos customer e product vêm carregados (com os dados essenciais para listagem) para evitar uma segunda chamada por cobrança.