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

amount
number
amount__gt
number
amount__gte
number
amount__lt
number
amount__lte
number
canceledAt
string<date-time>
canceledAt__gt
string<date-time>
canceledAt__gte
string<date-time>
canceledAt__lt
string<date-time>
canceledAt__lte
string<date-time>
createdAt
string<date-time>
createdAt__gt
string<date-time>
createdAt__gte
string<date-time>
createdAt__lt
string<date-time>
createdAt__lte
string<date-time>
currency
string

Filtra por moeda. Usa 'BRL' por padrão se não informado.

current_period
integer
current_period__gt
integer
current_period__gte
integer
current_period__lt
integer
current_period__lte
integer
current_situation
string
id
string[]

Valores múltiplos podem ser separados por vírgulas.

limit
integer

Number of results to return per page.

max_retries
integer
max_retries__gt
integer
max_retries__gte
integer
max_retries__lt
integer
max_retries__lte
integer
next_payment_date
string<date-time>
next_payment_date__gt
string<date-time>
next_payment_date__gte
string<date-time>
next_payment_date__lt
string<date-time>
next_payment_date__lte
string<date-time>
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

paid_payments_quantity
integer
paid_payments_quantity__gt
integer
paid_payments_quantity__gte
integer
paid_payments_quantity__lt
integer
paid_payments_quantity__lte
integer
paymentMethod
string[]

Valores múltiplos podem ser separados por vírgulas.

quantity_recurrences
integer
quantity_recurrences__gt
integer
quantity_recurrences__gte
integer
quantity_recurrences__lt
integer
quantity_recurrences__lte
integer
recurrence_period
integer
recurrence_period__gt
integer
recurrence_period__gte
integer
recurrence_period__lt
integer
recurrence_period__lte
integer
retry_interval
integer
retry_interval__gt
integer
retry_interval__gte
integer
retry_interval__lt
integer
retry_interval__lte
integer

A search term.

status
string[]

Valores múltiplos podem ser separados por vírgulas.

trial_days
integer
trial_days__gt
integer
trial_days__gte
integer
trial_days__lt
integer
trial_days__lte
integer
updatedAt
string<date-time>
updatedAt__gt
string<date-time>
updatedAt__gte
string<date-time>
updatedAt__lt
string<date-time>
updatedAt__lte
string<date-time>

Response

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