Obter uma fatura

Retorna o objeto invoice completo. O campo payment_intent aponta para a tentativa de pagamento mais recente da invoice quando existir. O campo hosted_invoice_url aponta para uma URL ativa da página pública dessa invoice. Se a invoice estiver open, a página permite pagamento; em estados finais, uma URL ativa mostra a fatura em modo de visualização.

Invoices na Chargefy representam cobranças de assinatura ou cobranças manuais vinculadas a um customer. Compras avulsas diretas não geram invoice — esse fluxo vive em Payment Intent. Trials geram uma invoice subscription_create com amount_total=0; a primeira cobrança paga após o trial chega como subscription_cycle.

O campo billing_reason aceita um destes valores:

Valor	Quando aparece
`subscription_create`	Primeira invoice de uma assinatura. Pode ter `amount_total=0` (trial).
`subscription_cycle`	Renovação periódica gerada pelo cycle. Cobre também a primeira cobrança paga após um trial.
`subscription_update`	Mudança no meio do ciclo (upgrade/downgrade/quantidade).
`manual`	Cobrança avulsa criada via admin ou API para um customer.

string

required

ID da invoice (inv_*).

curl -X GET "https://api.chargefy.io/v1/invoices/inv_AuHWjGcqr89wqPNE" \
  -H "Authorization: Bearer {{API_KEY}}"

200

{
  "id": "inv_AuHWjGcqr89wqPNE",
  "object": "invoice",
  "allow_late_payment": true,
  "amount_credit_balance_applied": 0,
  "amount_discount": 0,
  "amount_due": 9990,
  "amount_due_now": 9990,
  "amount_paid": 9990,
  "amount_remaining": 0,
  "amount_subtotal": 9990,
  "amount_tax": 0,
  "amount_total": 9990,
  "attempt_count": 1,
  "billing_reason": "subscription_cycle",
  "collection_method": "charge_automatically",
  "created_at": "2026-05-19T18:00:00Z",
  "currency": "brl",
  "customer": "cus_jN3U9vWCcv9MAGQ5",
  "customer_billing_address": {
    "city": "São Paulo",
    "country": "BR",
    "line1": "Av. Paulista, 1000",
    "line2": "Conjunto 101",
    "postal_code": "01310-100",
    "state": "SP"
  },
  "customer_billing_name": "Cliente Exemplo",
  "customer_document": "12345678901",
  "customer_document_type": "cpf",
  "customer_email": "nome@email.com",
  "customer_name": "Cliente Exemplo",
  "default_payment_method": "pm_dTGgkkLSMbatyMYg",
  "description": "Assinatura Plano Pro - Maio/2026",
  "due_date": "2026-05-19T12:00:00Z",
  "ending_balance": 0,
  "hosted_invoice_url": "https://billing.chargefy.io/invoice/ilink_8Pz6wKf3tVn2Qa9LmXr4Bc7D",
  "interest": {
    "percent_per_month": 1
  },
  "interest_amount": null,
  "invoice_pdf_url": "https://billing.chargefy.io/invoice/inv_AuHWjGcqr89wqPNE.pdf",
  "late_fee": {
    "type": "fixed",
    "value": 200
  },
  "late_fee_amount": null,
  "latest_charge": "ch_DHHcRQ5NtYJ4BGRE",
  "line_items": [
    {
      "id": "ili_uPrPN283q8CzqgJc",
      "object": "invoice_line_item",
      "amount_discount": 0,
      "amount_subtotal": 9990,
      "amount_tax": 0,
      "amount_total": 9990,
      "currency": "brl",
      "description": "Plano mensal",
      "discountable": true,
      "metadata": {},
      "period_end": "2026-06-19T18:00:00Z",
      "period_start": "2026-05-19T18:00:00Z",
      "position": 0,
      "price": "price_Z8UgTfYHU73xg13k",
      "price_data": null,
      "product": "prod_Y4hhVGDLrg3Lymfo",
      "proration": false,
      "proration_details": {},
      "quantity": 1,
      "recurring_interval": "month",
      "recurring_interval_count": 1,
      "subscription_item": "si_QpPiHqSa689UUUs3",
      "unit_amount": 9990
    }
  ],
  "livemode": true,
  "marked_uncollectible_at": null,
  "metadata": {},
  "next_payment_attempt": null,
  "number": "K7M2-0001",
  "paid_at": "2026-05-19T18:01:02Z",
  "payment_intent": "pi_EcNY2N8qNh7S6r87",
  "payment_method_types": [
    "credit_card"
  ],
  "starting_balance": 0,
  "statement_descriptor": "PLANO PRO",
  "status": "paid",
  "subscription": "sub_PxTBKNPvqrqTiQVL",
  "updated_at": "2026-05-19T18:01:02Z",
  "voided_at": null
}

Erros comuns

404

{
  "error": {
    "code": "resource_missing",
    "message": "Invoice not found",
    "type": "invalid_request_error"
  }
}

401

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Erros comuns

​Erros comuns

Erros comuns