EDPay
Docs
DocsRecursos da APISubscrições & Faturação Recorrente
Recorrência

Subscrições & Faturação Recorrente

Gestão de cobranças automáticas por ciclo, planos SaaS, mensalidades e emissão programada de faturas.

1. Criar Subscrição (Série Recorrente)

Inicializa um plano de cobrança periódica. A cada ciclo definido (interval_unit e interval_count), o motor de faturação emite automaticamente uma fatura com a respetiva payment_url para liquidação pelo cliente:

POST
/v1/invoice-series

Cabeçalhos Obrigatórios

HeaderTipoDescrição
X-EDPay-Public-KeystringChave pública da conta (pk_live_... ou pk_test_...).
X-EDPay-Private-KeystringChave privada de backend (sk_live_... ou sk_test_...).
Idempotency-KeystringIdentificador único da requisição para evitar duplicidade.
cURL
curl -X  POST "https://api-pay.edutecka.com/v1/invoice-series" \
  -H "X-EDPay-Public-Key: <PUBLIC_KEY>" \
  -H "X-EDPay-Private-Key: <PRIVATE_KEY>" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: req_sub_create_88192" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "cus_3f8a1b2c4d5e",
  "currency": "MZN",
  "description": "Plano SaaS Pro Mensal",
  "interval_unit": "month",
  "interval_count": 1,
  "starts_at": "2026-12-01T00:00:00Z",
  "due_days": 5,
  "items": [
    {
      "description": "Subscrição Mensal — Licença de Utilizador Pro",
      "quantity": 1,
      "unit_amount_minor": 350000
    }
  ]
}'

2. Listar Subscrições

Devolve as séries de faturação recorrentes configuradas para a organização, com filtro opcional por estado (active ou paused):

GET
/v1/invoice-series
cURL
curl -X  GET "https://api-pay.edutecka.com/v1/invoice-series?status=active" \
  -H "X-EDPay-Public-Key: <PUBLIC_KEY>" \
  -H "X-EDPay-Private-Key: <PRIVATE_KEY>" \
  -H "Accept: application/json"

3. Pausar Subscrição

Suspende temporariamente a emissão automática de faturas para a série indicada. Nenhuma nova fatura é gerada enquanto estiver em pausa:

POST
/v1/invoice-series/{id}/pause
cURL
curl -X  POST "https://api-pay.edutecka.com/v1/invoice-series/ser_9f8e7d6c5b4a/pause" \
  -H "X-EDPay-Public-Key: <PUBLIC_KEY>" \
  -H "X-EDPay-Private-Key: <PRIVATE_KEY>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

4. Retomar Subscrição

Reativa uma subscrição pausada e recalcula a data de emissão do próximo ciclo de cobrança:

POST
/v1/invoice-series/{id}/resume
cURL
curl -X  POST "https://api-pay.edutecka.com/v1/invoice-series/ser_9f8e7d6c5b4a/resume" \
  -H "X-EDPay-Public-Key: <PUBLIC_KEY>" \
  -H "X-EDPay-Private-Key: <PRIVATE_KEY>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'