Skip to main content
As rotas Trust MRR permitem que você compartilhe suas métricas de receita de forma transparente, seja integrando com plataformas Trust MRR ou consumindo diretamente as APIs para exibir em seu próprio site ou dashboard.

Estrutura

Informações do Merchant

Informações básicas da loja retornadas pela rota /public-mrr/merchant-info:
{
  "data": {
    "name": "Example Tech",
    "website": "https://www.example.com",
    "createdAt": "2024-12-06T18:53:31.756Z"
  },
  "error": null
}

MRR (Monthly Recurring Revenue)

Dados de receita recorrente mensal retornados pela rota /public-mrr/mrr:
{
  "data": {
    "mrr": 0,
    "totalActiveSubscriptions": 0
  },
  "error": null
}

Receita por Período

Dados de receita por período retornados pela rota /public-mrr/revenue:
{
  "data": {
    "totalRevenue": 150000,
    "totalTransactions": 45,
    "transactionsPerDay": {
      "2024-01-15": {
        "amount": 5000,
        "count": 3
      },
      "2024-01-16": {
        "amount": 3000,
        "count": 2
      }
    }
  },
  "error": null
}

Atributos:

{
  "name": "Example Tech",
} 
name : string.
Nome da loja
{
  "website": "https://www.example.com",
} 
website : string.
Website da loja
{
  "createdAt": "2024-12-06T18:53:31.756Z",
} 
createdAt : date-time.
Data de criação da loja
{
  "mrr": 0,
} 
mrr : number.
Receita recorrente mensal em centavos. Valor 0 indica que não há receita recorrente no momento.
{
  "totalActiveSubscriptions": 0,
} 
totalActiveSubscriptions : integer.
Total de assinaturas ativas. Valor 0 indica que não há assinaturas ativas no momento.
{
  "totalRevenue": 150000,
} 
totalRevenue : number.
Receita total do período em centavos
{
  "totalTransactions": 45,
} 
totalTransactions : integer.
Total de transações no período
{
  "transactionsPerDay": {
    "2024-01-15": {
      "amount": 5000,
      "count": 3
    },
    "2024-01-16": {
      "amount": 3000,
      "count": 2
    }
  }
} 
transactionsPerDay : object.
Objeto com transações agrupadas por dia (chave é a data no formato YYYY-MM-DD)
  • amount : number.
    Valor total das transações do dia em centavos
  • count : integer.
    Quantidade de transações do dia
Todos os valores monetários são retornados em centavos. Para converter para reais, divida por 100. Por exemplo: 150000 centavos = R$ 1.500,00