Pular para o conteúdo principal
Atualizar um rascunho
Edita somente uma invoice draft. Os campos ausentes são preservados. Não é possível trocar cliente, moeda ou assinatura. Uma invoice já finalizada retorna 409. A API recalcula os totais a partir dos itens no salvamento. A edição não cria pagamento, link público ou e-mail. Para períodos de assinatura ambíguos, novos itens são recusados; os itens existentes podem ser enviados com seu id, preservando período, vínculo e prorrata.
string
obrigatório
ID da invoice (inv_*).
integer
Valor em centavos, inclusive zero. Alternativa a line_items.
array
Substitui todos os itens. Usa o mesmo formato da criação. Em um item existente, envie id para preservar seu período e vínculo com a assinatura. Não envie amount junto.
string | null
Descrição da cobrança.
string | null
Identificador que aparecerá na cobrança.
string
Vencimento em ISO 8601.
integer
Prazo em dias, como alternativa a due_date.
string
send_invoice ou charge_automatically. O segundo exige uma assinatura.
string | null
Método do mesmo cliente e organização.
array
Métodos permitidos: pix, boleto, credit_card. Pelo menos um.
object
Mesmo contrato de parcelamento das assinaturas: payment_method_options.credit_card.installments.plan com type: "fixed_count", interval: "month" e count de 2 até o limite configurado (máximo 12). O principal deve comportar pelo menos R$ 7,00 por parcela. Envie payment_method_options.credit_card: null para remover o plano fixo.
object | null
Multa no mesmo formato da criação; null desliga.
object | null
Juros no mesmo formato da criação; null desliga.
boolean
Permite pagamento após o vencimento.
string
chargefy envia e-mail e lembretes depois da finalização; manual deixa a entrega com você.
integer
Dias antes do vencimento. Inteiro não negativo.
integer
Dias após o vencimento. Inteiro não negativo.
object
Metadados do integrador.