Saltar al contenido

Relatório de assinaturas (MRR, novas, canceladas, churn)

GET/api/reports/subscriptions

Auth
Requiere token
Quién puede:
owner
admin
finance
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

F-46. Owner, admin ou finance.

`series[]` por período: `mrr` (receita recorrente mensal no fim do período: cada assinatura pagante convertida para o mês — anual ÷ 12, semanal × 52 ÷ 12), `active` (pagantes no fim do período), `new`, `canceled`, `churnRate` (% de canceladas sobre as ativas no início do período; `null` quando não havia nenhuma), `trialing` e `courtesy` (cortesias vigentes, fora do MRR).

O histórico é reconstruído pelas datas de início e de fim de cada assinatura. Mudanças de status que não deixam data (um atraso que se resolveu, uma pausa) só aparecem no retrato atual `current` (`mrr`, `arr`, `paying`, `byStatus`, `canceling` — vão encerrar no fim do período —, `pastDue`, `courtesy`). `byPlan[]` traz, por plano, as pagantes e o MRR de hoje e as novas/canceladas da janela. `downsell` conta ofertas de última chance exibidas e aceitas na janela.

Parámetros

NombreDóndeTipoDescripción
intervalopcionalqueryday | week | monthTamanho de cada período da série. `week` começa na segunda-feira. Rótulo do período: `YYYY-MM-DD` (dia ou segunda-feira da semana) ou `YYYY-MM` (mês). Máximo de períodos por consulta: 366 dias, 156 semanas ou 120 meses.
fromopcionalquerystring (date)Primeiro dia (inclusive), no fuso do relatório, alargado para o início do período (com `interval=month`, `2026-03-15` vira `2026-03-01`). Padrão: 30 dias, 12 semanas ou 12 meses antes de `to`.
toopcionalquerystring (date)Último dia (inclusive), alargado até o fim do período. Padrão hoje.
timezoneopcionalquerystringFuso IANA em que os períodos são contados. Padrão: o fuso do país da comunidade (o mesmo dos prazos do call4papers). A resposta devolve o fuso usado em `timezone`.
currencyopcionalqueryBRL | USD | EUR | GBP | MXN | ARS

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respuestas

CódigoDescripción
200Série pronta para gráfico.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Ejemplo con curl

curl -X GET "https://api.memberfy.net/api/reports/subscriptions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"