Skip to main content
GET
Obter uma fatura com seus itens
Requer a ação do IAM billing:GetInvoice. Consulte permissões de faturamento para obter a lista completa, o que cada uma cobre e um exemplo de política.

Autorizações

Authorization
string
header
obrigatório

Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.

Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.

Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.

Parâmetros de caminho

invoice_id
string<uuid>
obrigatório

Resposta

A fatura, incluindo o uso e linhas de crédito.

crn
string
obrigatório

Identidade de fatura global com escopo de organização.

Exemplo:

"crn:billing:::invoice/550e8400-e29b-41d4-a716-446655440000"

id
string<uuid>
obrigatório
invoice_number
string
obrigatório
Exemplo:

"INV-2026-000042"

period_start
string<date>
obrigatório

Primeiro dia do mês faturado UTC.

Exemplo:

"2026-06-01"

period_end
string<date>
obrigatório

Fim exclusivo (primeiro dia do mês seguinte).

Exemplo:

"2026-07-01"

subtotal
string
obrigatório
Exemplo:

"128.40"

credits_applied
string
obrigatório
Exemplo:

"20.00"

total
string
obrigatório
Exemplo:

"108.40"

currency
string
obrigatório
Exemplo:

"BRL"

refunded_amount
string
obrigatório

Reembolsos confirmados menos reversões de reembolsos com falha, em BRL.

Exemplo:

"25.00"

disputed_amount
string
obrigatório

Capital da disputa retirado menos fundos repostos; exclui taxas de provedor.

Exemplo:

"0.00"

status
enum<string>
obrigatório
Opções disponíveis:
open,
paid,
past_due,
uncollectible,
void
created_at
string<date-time>
obrigatório
issued_at
string<date-time> | null
due_at
string<date-time> | null
paid_at
string<date-time> | null
pdf_url
string

Caminho do extrato PDF, renderizado sob demanda por GET /v1/invoices/{invoice_id}/pdf sob a mesma autorização que este documento.

Exemplo:

"/v1/invoices/019fbbe8-7201-7aad-9475-e6ea0631a4a3/pdf"

items
object[]

Itens de linha; presentes apenas no ponto de extremidade de detalhe.