Skip to main content
GET
cURL

Escopo

O que é este endpoint?

Lista todas as assinaturas canceladas ou inativas do seu negócio. A resposta inclui métricas agregadas com o valor financeiro em risco e a quantidade de clientes afetados.

Casos de uso

Compare períodos e veja se a taxa de cancelamento está caindo ou subindo. Se subiu após uma mudança no produto, é hora de rever o que foi feito.
Um aumento repentino pode indicar problema técnico, insatisfação ou comunicação confusa. Quanto antes identificar, mais rápido você corrige.
Subiu o preço? Monitore este endpoint nos 30 dias seguintes para saber se a mudança afetou a permanência dos assinantes.
Filtre por mês ou trimestre para entender se o negócio recorrente está estável, crescendo ou perdendo fôlego.
O campo total_at_risk_value mostra o valor total das assinaturas canceladas e inativas. Isso ajuda a dimensionar o problema em dinheiro.
Cancelamentos frequentes costumam preceder reclamações. Use os dados para investigar o que está errado antes que o churn se espalhe.

Insights que podem ser obtidos

Use os filtros de data para cruzar picos de cancelamento com mudanças recentes no produto, preço ou comunicação.
Lançou uma nova funcionalidade ou campanha? Compare os cancelamentos antes e depois para medir o efeito real.
Se o valor em risco cresce mês após mês, a receita recorrente vai cair em breve. Agir preventivamente é mais barato que recuperar clientes perdidos.
Analise a evolução dos cancelamentos ao longo do ano para identificar os melhores momentos para disparar ofertas de win-back.

Filtros Disponíveis

Filtros podem ser combinados para refinar os resultados.Exemplo: ?status=canceled&createdAt__gte=2025-01-01 — Filtra assinaturas canceladas desde janeiro de 2025.
  • status — Status da assinatura (canceled, inactive, ou ambos separados por vírgula)
Exemplo: ?status=canceled,inactive — Traz tanto canceladas quanto inativas
  • current_period — Período atual da assinatura (número inteiro)
  • current_period__gt — Período maior que
  • current_period__lt — Período menor que
Exemplo: ?current_period__gt=3 — Assinaturas que já passaram do 3º período
  • createdAt — Data de criação (suporta __gte, __lte, __gt, __lt)
  • canceledAt — Data de cancelamento (suporta __gte, __lte, __gt, __lt)
  • next_payment_date — Próximo pagamento (suporta __gte, __lte, __gt, __lt)
Formato de data: YYYY-MM-DD ou ISO 8601 YYYY-MM-DDTHH:MM:SS±hh:mm
Exemplo: ?canceledAt__gte=2025-01-01&canceledAt__lt=2025-02-01 — Cancelamentos de janeiro de 2025
  • limit — Número de resultados por página (padrão: 100)
  • offset — Índice do primeiro resultado
Exemplo: ?limit=50&offset=50 — Página 2 com 50 resultados por página

Métricas Retornadas

A resposta inclui um objeto metrics com as seguintes informações financeiras e quantitativas:
Dados sensíveis do cliente são limitados por padrão. Apenas name é retornado no objeto customer.

Authorizations

Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Query Parameters

limit
integer

Número de resultados a serem retornados por página.

offset
integer

Índice do primeiro resultado a ser retornado.

status
string

Filtra por status da assinatura (canceled, inactive, ou ambos separados por vírgula)

current_period
integer

Filtra pelo período atual da assinatura

current_period__gt
integer

Filtra por período maior que

current_period__lt
integer

Filtra por período menor que

createdAt__gte
string<date-time>

Filtra por data de criação maior ou igual (formato ISO 8601)

createdAt__lte
string<date-time>

Filtra por data de criação menor ou igual (formato ISO 8601)

canceledAt__gte
string<date-time>

Filtra por data de cancelamento maior ou igual (formato ISO 8601)

canceledAt__lte
string<date-time>

Filtra por data de cancelamento menor ou igual (formato ISO 8601)

Response

Corpo da resposta status 200

count
integer
required

Total de resultados

results
object[]
required
metrics
object
required
next
string<uri> | null

URL da próxima página

previous
string<uri> | null

URL da página anterior