Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Retorna métricas agregadas da organização, como receita, assinaturas ativas e churn, para um período especificado.

​
Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization.

​
Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
startDatestringSimData de início no formato YYYY-MM-DD
endDatestringSimData de fim no formato YYYY-MM-DD
intervalstringNãoIntervalo de agrupamento: day, week, month (default: month)
organizationIdstringNãoID da organização

​
Campos da Resposta

CampoTipoDescrição
periodsarrayLista de períodos com métricas
periods[].datestringData do período
periods[].revenueintegerReceita em centavos
periods[].activeSubscriptionsintegerAssinaturas ativas
periods[].newSubscriptionsintegerNovas assinaturas
periods[].canceledSubscriptionsintegerAssinaturas canceladas
periods[].churnRatenumberTaxa de churn (%)
periods[].mrrintegerReceita recorrente mensal em centavos
totalsobjectTotais do período
totals.totalRevenueintegerReceita total em centavos
totals.totalSalesintegerTotal de vendas

​
Exemplo de Requisição

curl -X GET "https://api.chargefy.io/api/v1/metrics?startDate=2026-01-01&endDate=2026-03-12&interval=month" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​
Exemplo de Resposta

{
  "periods": [
    {
      "date": "2026-01-01",
      "revenue": 1250000,
      "activeSubscriptions": 120,
      "newSubscriptions": 15,
      "canceledSubscriptions": 3,
      "churnRate": 2.5,
      "mrr": 450000
    },
    {
      "date": "2026-02-01",
      "revenue": 1380000,
      "activeSubscriptions": 132,
      "newSubscriptions": 18,
      "canceledSubscriptions": 6,
      "churnRate": 4.5,
      "mrr": 495000
    },
    {
      "date": "2026-03-01",
      "revenue": 1420000,
      "activeSubscriptions": 140,
      "newSubscriptions": 12,
      "canceledSubscriptions": 4,
      "churnRate": 3.0,
      "mrr": 520000
    }
  ],
  "totals": {
    "totalRevenue": 4050000,
    "totalSales": 312
  }
}