Séries temporais

Churn

Série de perda de MRR no período, fatiada por dia ou por mês. Esta série temporal considera assinaturas canceladas ou expiradas (status CANCELED ou EXPIRED) que já pagaram pelo menos um ciclo. Deste modo, assinaturas canceladas ou expiradas que nunca tiveram um ciclo pago não são consideradas no cálculo do churn.

GET/v1/analytics/churn

Base URL Produção:https://api.validapay.com.br

Disponível apenas em produção. Esta rota não existe no sandbox: use credenciais e a URL de produção.

Valores monetários vêm como string decimal em reais (ex.: "12345.67").

Dias/meses sem evento não geram linha. A soma dos dias do mês fecha com o ponto mensal e com churn.mrr do summary no mesmo recorte.

Case de uso:

Como integrador, quero a curva de evolução do churn no tempo e poder cruzar com as demais séries temporais de assinaturas.

Séries temporais

Simulação de consumo de rotas

Abaixo você pode simular o consumo da série temporal descrita acima. Além disso, você pode simular as séries temporais descritas nas próximas seções.

Perda de MRR (Churn)

Perda de MRR diária - Últimas 4 semanas

Carregando série demo…

Authorizations

bearer

Authorization

string obrigatório

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

subscriptions/read

Query Parameters

granularityopcional

month (default) ou day

day

startDateopcional

Início diário YYYY-MM-DD

2026-08-01

endDateopcional

Fim diário YYYY-MM-DD

2026-08-14

startMonthopcional

Início mensal YYYY-MM

endMonthopcional

Fim mensal YYYY-MM

← Anterior

Inadimplência

Listar Notas Fiscais

const url = 'https://api.validapay.com.br/v1/analytics/churn?granularity=day&startDate=2026-08-01&endDate=2026-08-14';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200Diário▾

JSON

{
  "accountId": "460851686",
  "items": [
    { "period": "2026-08-10", "mrr": "149.79", "subscriptionCount": 1, "currency": "BRL" },
    { "period": "2026-08-13", "mrr": "896.98", "subscriptionCount": 2, "currency": "BRL" }
  ]
}

200Mensal▾

JSON

{
  "accountId": "460851686",
  "items": [
    { "period": "2026-08", "mrr": "1046.77", "subscriptionCount": 3, "currency": "BRL" }
  ]
}

400Intervalo de datas inválido▾

JSON

{
  "error": {
    "message": "startDate e endDate devem ser informados juntos",
    "code": "INVALID_DATE_RANGE",
    "details": null,
    "timestamp": "2026-10-10T18:00:00.000Z"
  }
}

← Anterior

Inadimplência

Listar Notas Fiscais