Cancelar fatura
Cancela uma fatura aberta e inutiliza as tentativas de pagamento e os QR Codes PIX ainda ativos.
A operação grava o evento invoice.voided, cujo data.object tem a mesma representação
devolvida nesta resposta.
Uma fatura paga, incobrável ou já cancelada não pode ser cancelada novamente. Se uma captura de cartão ou uma confirmação PIX estiver em andamento, aguarde seu resultado antes de repetir.
Limite de taxa: 10 requisições por minuto por chave de API.
Authorizations
A chave de API usada para autenticar a requisição e identificar a sua conta.
Exemplo: Authorization: ApiKey my-secure-key
Path Parameters
ID da fatura, no formato TypeID com prefixo in_.
^in_[0-9a-z]{26}$"in_01h455vb4pex5vsknk084sn02q"
Response
Fatura cancelada
ID único da fatura, no formato TypeID com prefixo in_.
^in_[0-9a-z]{26}$"in_01h455vb4pex5vsknk084sn02q"
Tipo do objeto. Sempre 'invoice'.
invoice "invoice"
Valor a pagar em centavos. R$ 99,90 = 9990.
9990
Timestamp Unix da criação da fatura.
1704672000
Moeda do valor. Sempre 'brl' (Real brasileiro).
brl "brl"
ID do cliente associado à fatura, no formato TypeID com prefixo cus_.
^cus_[0-9a-z]{26}$"cus_01h455vb4pex5vsknk084sn02p"
Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.
true
Status atual da fatura.
- draft: Rascunho, ainda não finalizada.
- open: Aberta, aguardando pagamento.
- paid: Paga.
- uncollectible: Marcada como incobrável.
- void: Cancelada.
draft, open, paid, uncollectible, void "open"
Valor total da fatura em centavos. R$ 99,90 = 9990.
9990
Valor já pago em centavos. R$ 99,90 = 9990.
0
Valor estornado em centavos. Permanece separado de status: uma fatura
paga continua com status: paid depois de um estorno total ou parcial.
0
Valor restante a pagar em centavos. R$ 99,90 = 9990.
9990
E-mail do cliente.
"joao.silva@exemplo.com"
Nome do cliente.
"João Silva"
Código externo para integração com outros sistemas. Único por conta.
"PEDIDO-123"
Indica se a fatura foi paga.
false
ID da cobrança associada à fatura, no formato TypeID com prefixo pi_.
null enquanto a fatura ainda não tem cobrança gerada.
"pi_01h455vb4pex5vsknk084sn02r"
Timestamps de quando a fatura mudou de status. Campos são null se a transição ainda não ocorreu.
ID da assinatura associada (se aplicável), no formato TypeID com prefixo sub_.
"sub_01h455vb4pex5vsknk084sn02s"

