Skip to main content
Cria uma invoice em status open. Os valores, itens de linha, vencimento e snapshots do customer ficam fixos desde a criação. Para corrigir esses dados, cancele a invoice (void) e crie uma nova. Só customer é obrigatório, mais a cobrança em si: line_items ou amount. Todo o resto tem padrão ou é resolvido pela Chargefy. Sem nenhum dos dois o request falha com 400; se os dois forem enviados, line_items prevalece e amount é ignorado. Dentro de cada item de line_items, a regra é estrita: exatamente um de price ou price_data — os dois juntos ou nenhum dá erro 400. Para uma cobrança avulsa (com vencimento, multa/juros e URL de fatura para o cliente), envie due_date, defina late_fee/interest quando quiser penalidades por atraso, e deixe delivery: "chargefy" para que a Chargefy envie a fatura por email e cuide dos lembretes. Use amount quando a cobrança não tiver produtos. A resposta inclui hosted_invoice_url, uma URL pública ativa em billing.chargefy.io/invoice/:token. Compartilhe esse campo quando quiser que o cliente visualize ou pague a invoice manualmente. O token pertence à invoice criada, pode ser renovado pela Chargefy, e não é um payment_link reutilizável.
​
string
required
Customer que receberá a invoice (cus_*).
​
integer
Valor total em centavos (inteiro positivo), quando a cobrança não tem produtos. Vira um item de linha único com quantity: 1 e a description enviada no top-level. Considerado apenas quando line_items está ausente ou vazio.
​
array
Itens da invoice, para cobranças com produtos. Obrigatório quando você não envia amount; deve ser um array não-vazio. Todos os itens usam a mesma moeda da invoice.
​
string
Código ISO 4217 em minúsculas para a invoice. Padrão: a moeda dos itens (brl para itens inline sem moeda própria).
​
string
Método de cobrança. Padrão: send_invoice.
​
string
Subscription (sub_*) à qual a invoice pertence. É obrigatória quando collection_method é charge_automatically, porque o worker de cobrança automática processa invoices de assinatura. Para cobrança avulsa, use send_invoice e compartilhe hosted_invoice_url.
​
string
Vencimento como instante absoluto em RFC 3339, com Z ou offset numérico (ex.: 2026-06-10T12:00:00Z ou 2026-06-10T09:00:00-03:00). O instante é preservado exatamente como enviado.Só é válido com collection_method igual a send_invoice, e é mutuamente exclusivo com days_until_due — envie um ou outro. Um dos dois é obrigatório em send_invoice.Formatos recusados com 400:
Ao converter um dia escolhido pelo vendedor em instante, ancore ao meio-dia UTC (12:00:00Z) — meia-noite fica na fronteira do dia e é lida como a data anterior por quem está a oeste. Veja Datas, fusos e moedas.
​
integer
Número de dias, a partir da criação, até o vencimento. Só é válido com collection_method igual a send_invoice, e é mutuamente exclusivo com due_date.O vencimento resultante é ancorado ao meio-dia UTC do dia alvo: 0 vence hoje, 7 vence daqui a sete dias. A resposta devolve o due_date já resolvido.
​
string
Descrição da invoice, exibida na fatura. Com amount, também vira a descrição do item de linha único.
​
string
Descritor exibido para o cliente na fatura.
​
object
Multa aplicada uma vez após o vencimento.
​
object
Juros mensais que acumulam por dia após o vencimento.
​
boolean
Permite pagamento após o vencimento (multa/juros acumulam, lembretes continuam até o limite). Padrão: true quando há late_fee ou interest; senão o padrão configurado na organização; senão false.
​
array
Meios de pagamento permitidos na página da invoice. Padrão: os métodos habilitados no checkout da organização (todos, quando não configurado).
​
string
Quem entrega a fatura ao cliente. Padrão: chargefy.
​
string
Payment method salvo (pm_*) escolhido como padrão desta invoice. Precisa pertencer ao customer e estar válido. Ao pagar sem payment_method explícito, a Chargefy tenta usar o padrão da invoice, depois o padrão da subscription, e por fim o padrão do customer.
​
object
Metadata livre. Padrão {}.

​
O que a Chargefy resolve sozinha

  • due_date — sem valor explícito, vence em agora + o prazo padrão da organização (0 dias quando não configurado).
  • payment_method_types — herdam os métodos habilitados no checkout da organização.
  • allow_late_payment — vira true automaticamente quando você define late_fee ou interest.
  • Envio e lembretes — com delivery: "chargefy", a fatura é enviada por email na criação quando já está vencendo e os lembretes seguintes são agendados.
  • Snapshot do customer — nome, email, documento e endereço de cobrança são copiados do customer no momento da criação.
  • hosted_invoice_url — gerada (e renovada quando expira) pela Chargefy.
  • amount → item de linha — o valor avulso vira um item único com quantity: 1 e a description da invoice.