LinkPix
Referência da API

Faturas Recorrentes

Automatizar cobranças mensais e assinaturas

Faturas Recorrentes (Recurring Invoices)

Automatize cobranças recorrentes e assinaturas.

Criar Fatura Recorrente

POST /api/v1/recurring-invoices
{
  "client_id": "uuid-do-cliente",
  "name": "Assinatura Mensal - Hospedagem",
  "frequency": "monthly",
  "billing_day": 5,
  "start_date": "2026-02-01",
  "items": [
    {
      "description": "Hospedagem Premium",
      "quantity": 1,
      "unit_price": 199.90
    }
  ]
}

Campos obrigatórios:

  • client_id - UUID do cliente
  • name - Nome da assinatura
  • frequency - monthly, bimonthly, quarterly, semiannual, annual
  • billing_day - Dia do mês (1-31)
  • start_date - Data de início
  • items - Array de itens

As faturas serão geradas automaticamente 5 dias antes do vencimento!

Frequências Disponíveis

  • monthly - Todo mês
  • bimonthly - A cada 2 meses
  • quarterly - A cada 3 meses (trimestral)
  • semiannual - A cada 6 meses (semestral)
  • annual - Uma vez por ano (anual)
  • custom - Intervalo personalizado (requer custom_interval_days)

Listar Faturas Recorrentes

GET /api/v1/recurring-invoices?page=1&limit=50&status=active

Status disponíveis:

  • active - Ativa
  • paused - Pausada
  • cancelled - Cancelada
  • expired - Expirada

Buscar Fatura Recorrente

GET /api/v1/recurring-invoices/:id

Atualizar Fatura Recorrente

PATCH /api/v1/recurring-invoices/:id
{
  "billing_day": 10,
  "end_date": "2027-12-31"
}

Cancelar Fatura Recorrente

DELETE /api/v1/recurring-invoices/:id

O DELETE não deleta fisicamente, apenas cancela a assinatura (status: cancelled).

On this page