Quando usar
Como funciona
- O token
mrr_é só de leitura. Ele vai no headerAuthorization: Bearer mrr_...e não altera nada na sua conta. - O token só vale nas rotas de Public MRR. Em qualquer outra rota, a API responde
401 Unauthorized. As rotas de Public MRR também não aceitam a chave de API: com ela, a resposta é o mesmo401. - Os dados são sempre de produção, mesmo que o token tenha sido gerado com o Modo Teste ligado.
- O token não muda depois de gerado.
- As rotas existem na v1 e na v2. Use a v2:
https://api.abacatepay.com/v2/public-mrr/.... - Os valores são em centavos (
129900= R$ 1.299,00).
Como o MRR é calculado
- O MRR soma as assinaturas ativas que já pagam, cada uma com o valor de um mês: a anual conta 1/12, a semestral 1/6, a trimestral 1/3, e assim por diante.
- A assinatura em período de teste (trial) conta em
totalActiveSubscriptions, mas ainda não conta no MRR. Ela entra no MRR quando o trial acaba. - A assinatura cancelada sai das duas contas na data do cancelamento.
- O MRR por dia é o MRR no fim de cada dia, no horário de Brasília, com até 366 dias por consulta.
- A receita por período soma as vendas de cada dia, no horário de Brasília: o total em
totalRevenue, a quantidade emtotalTransactionse o detalhe por dia emtransactionsPerDay. O período precisa ter pelo menos dois dias: comstartDateigual aendDate, a API respondeEnd date must be after start date.
Como gerar o token no dashboard
1
Abra os plugins
No dashboard, vá em Integração → Plugins e abra o Public MRR.
2
Instale o plugin
Clique em Add. A instalação gera o token.
3
Copie o token
Na seção Token de Acesso, clique em Mostrar e copie o token (
mrr_...). A mesma página lista as rotas e tem botões para copiar a URL e o comando cURL de cada uma.Pela API
mrr.value é o MRR em centavos, e totalActiveSubscriptions.value é a quantidade de assinaturas ativas.
As datas vão em
startDate e endDate, no formato YYYY-MM-DD.
Perguntas frequentes
O token mrr_ serve para criar cobranças ou ler clientes?
O token mrr_ serve para criar cobranças ou ler clientes?
Não. Ele só vale nas rotas de Public MRR. Para o resto da API, use uma chave de API.
Por que as assinaturas em trial não entram no MRR?
Por que as assinaturas em trial não entram no MRR?
Elas ainda não pagam. Contam em
totalActiveSubscriptions e entram no MRR quando o trial acaba.Por que recebo “End date must be after start date” na receita?
Por que recebo “End date must be after start date” na receita?
A receita por período precisa de pelo menos dois dias. Use um
endDate depois do startDate. O MRR por dia aceita um dia só.O token mostra os dados do Modo Teste?
O token mostra os dados do Modo Teste?
Não. As rotas de Public MRR sempre leem os dados de produção.
O número mudou na loja, mas não na API. Por quê?
O número mudou na loja, mas não na API. Por quê?
Os resultados ficam em cache: o MRR por até 1 minuto, a receita e o MRR por dia por até 1 hora.