Recorrência & Mensalidades (NFS-e)

Listar Contratos Recorrentes

Retorna a lista de contratos de cobrança recorrente de NFS-e (mensalidades) da empresa com filtros de busca, paginação e indicadores em tempo real de MRR (Receita Recorrente Mensal), quantidade de contratos ativos e previsões do mês corrente.

GET
https://api.nfer.me
/v1/recurring-contracts

Authorizations

X-API-Key
string
header
required

Chave de API emitida no painel NFER enviada no header da requisição.

Query Parameters

search
string
opcional

Busca textual por nome do tomador, CPF/CNPJ ou descrição do serviço.

Exemplo:Tecnologia
active
boolean
opcional

Filtra por contratos ativos (true) ou pausados (false).

page
integer
opcional
default:1

Número da página (padrão: 1).

limit
integer
opcional
default:20

Quantidade de registros por página (máx. 100, padrão: 20).

Response

application/json

Lista paginada de contratos recorrentes e métricas financeiras consolidadas.

items
object[]
opcional
total
integer
opcional
Exemplo:1
page
integer
opcional
Exemplo:1
limit
integer
opcional
Exemplo:20
metrics
object
opcional
Listar Contratos Recorrentes
curl --request GET \
  --url https://api.nfer.me/v1/recurring-contracts \
  --header 'X-API-Key: <sua_chave_api>'
{
  "items": [
    {
      "id": "a819c940-bf72-46a2-9659-192518e11a91",
      "customer_name": "Poliana Lima",
      "customer_document": "04022170123",
      "customer_email": "poliana@exemplo.com.br",
      "description": "Licença de software SaaS e suporte técnico - ref. {{mes_ano}}",
      "amount": 1500,
      "service_code": "010701",
      "day_of_month": 10,
      "next_issue_date": "2026-11-10",
      "active": true,
      "duration_type": "indefinite",
      "send_email": true,
      "total_issued_count": 5,
      "total_issued_amount": 7500,
      "last_issued_at": "2026-10-10T09:00:00.000Z",
      "created_at": "2026-05-10T12:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20,
  "metrics": {
    "mrr": 1500,
    "activeCount": 1,
    "totalCount": 1,
    "dueThisMonth": 1
  }
}