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.

Gera uma cobrança extra para uma assinatura ativa, fora do ciclo de recorrência padrão. A cobrança é criada no gateway de pagamentos e registrada na base de dados.

​
Autenticação

Requer um token de acesso válido (CHARGEFY_ACCESS_TOKEN) no header Authorization. Escopos necessários: web:write ou subscriptions:write.

​
Parâmetros de Path

ParâmetroTipoObrigatórioDescrição
idstringSimID da assinatura

​
Parâmetros do Body

ParâmetroTipoObrigatórioDescrição
amountnumberSimValor em centavos (ex: 9900 para R$ 99,00). Deve ser positivo
due_datestringSimData de vencimento no formato ISO (YYYY-MM-DD)
descriptionstringNãoDescrição da cobrança
expiration_datestringNãoData de expiração da cobrança no formato ISO (YYYY-MM-DD)
no_fees_installmentsbooleanNãoSe true, parcelas sem juros. Padrão: false
Somente assinaturas com status: active, trialing, unpaid ou past_due e com identificador de recorrência interno (zoop_subscription_id) configurado podem receber cobranças avulsas.

​
Campos da Resposta

CampoTipoDescrição
idstringID da invoice criada
zoop_invoice_idstringID da invoice no gateway (campo da API)
subscription_idstringID da assinatura
organization_idstringID da organização
amountnumberValor em centavos
currencystringMoeda (BRL)
descriptionstring | nullDescrição da cobrança
due_datestringData de vencimento
expiration_datestring | nullData de expiração
payment_methodstringMétodo de pagamento (credit)
statusstringStatus da invoice: pending, paid, voided, failed
no_fees_installmentsbooleanParcelas sem juros
paid_atdatetime | nullData em que a invoice foi paga
created_atdatetimeData de criação
modified_atdatetimeData da última modificação

​
Exemplo de Requisição

curl -X POST "https://api.chargefy.io/api/v1/subscriptions/sub_1a2b3c4d/invoices" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 9900,
    "due_date": "2026-04-10",
    "description": "Taxa de setup"
  }'

​
Exemplo de Resposta

{
  "id": "inv_abc123",
  "zoop_invoice_id": "gw_inv_xyz789",
  "subscription_id": "sub_1a2b3c4d",
  "organization_id": "org_def456",
  "amount": 9900,
  "currency": "BRL",
  "description": "Taxa de setup",
  "due_date": "2026-04-10",
  "expiration_date": null,
  "payment_method": "credit",
  "status": "pending",
  "no_fees_installments": false,
  "created_at": "2026-03-20T10:00:00Z"
}