Skip to main content
GET
Consultar fatura
O id da fatura é um código numérico de 6 dígitos, como 482913. Ele aparece em latest_invoice.id da assinatura e na listagem de faturas.
Esta rota encontra apenas faturas de assinaturas. O identificador de um pedido avulso retorna 404 (resource_missing). Para pedidos, use Consultar pedido.
Quando status é failed, a resposta traz o motivo em failure_reason. Quando o cliente precisa agir, next_action traz o QR Code PIX ou os dados do código de verificação.

Authorizations

Authorization
string
header
required

Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Dev mode). Envie no header Authorization: Bearer <chave>. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header account. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.

Path Parameters

id
string
required

Identificador do recurso (o campo id devolvido pela API)

Response

Fatura encontrada

Fatura de um ciclo da assinatura. processing: em processamento. requires_action: PIX aguardando pagamento ou verificação por código (veja next_action). paid: paga. failed: recusada (veja failure_reason). canceled: cancelada. refunded e partially_refunded: estornada. chargeback: contestada.

id
string
Example:

"719305"

object
enum<string>
Available options:
invoice
subscription
string
Example:

"sub_4Hn8Qw2Rt6Yp1Zx3"

number
integer

Número da fatura na assinatura

Example:

1

status
enum<string>
Available options:
processing,
requires_action,
paid,
failed,
canceled,
refunded,
partially_refunded,
chargeback
currency
string
Example:

"brl"

amount
integer

Valor da fatura, em centavos, já com descontos e acréscimos

Example:

9000

attempts
integer

Tentativas de cobrança

items
object[]
discounts
object[]
increments
object[]
payments
object[]
next_action
object | null

O que precisa acontecer para o pagamento seguir. pix_display_qr_code: exiba o QR Code para o pagador. otp_confirmation: a análise de fraude pediu verificação — nada é cobrado até o código ser confirmado na rota /confirm.

created_at
string
failure_reason
object

Motivo da recusa. Presente só quando o status é failed