Séries temporais

MRRM

A série temporal MRRM (MRR by Method) é a própria série do MRR fatiada por método de pagamento (campo paymentType). Cada ponto é o estoque naquele período: não some o intervalo.

GET/v1/analytics/mrr/by-payment-method/series

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").

Identidade por period: totalMrr = soma de methods[].mrr = mrr do mesmo period em /mrr.

Case de uso:

Como integrador, quero ver quanto do MRR vem de Pix, boleto e cartão ao longo do tempo.

Séries temporais

Simulação de MRRM

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.

MRR

Receita mensal recorrente por método de pagamento

Carregando série demo…

MRR por método

MRR por método de pagamento

O card do painel lê o estoque num ponto. Semanal usa o início da janela, Mensal o fim do mês e Personalizado o dia escolhido. Semestral e Anual pedem o mês corrente em granularity=month.

Carregando MRR por método…

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-16

startMonthopcional

Início mensal YYYY-MM

endMonthopcional

Fim mensal YYYY-MM

← Anterior

MRR

Inadimplência

const url = 'https://api.validapay.com.br/v1/analytics/mrr/by-payment-method/series?granularity=day&startDate=2026-08-01&endDate=2026-08-16';

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

200▾

JSON

{
  "accountId": "460851686",
  "granularity": "day",
  "startDate": "2026-08-01",
  "endDate": "2026-08-16",
  "items": [
    {
      "period": "2026-08-14",
      "totalMrr": "41568.55",
      "methods": [
        {
          "paymentType": "BOLETO",
          "mrr": "37516.18",
          "subscriptionCount": 178,
          "customerCount": 178
        },
        {
          "paymentType": "CREDIT_CARD",
          "mrr": "2990.37",
          "subscriptionCount": 42,
          "customerCount": 40
        },
        {
          "paymentType": "PIX",
          "mrr": "1062.00",
          "subscriptionCount": 15,
          "customerCount": 15
        }
      ]
    }
  ]
}

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

MRR

Inadimplência