Skip to main content
GET
Obtener una factura con sus conceptos
Requiere la acción de IAM billing:GetInvoice. Consulta permisos de facturación para obtener la lista completa, lo que cubre cada una y un ejemplo de política.

Autorizaciones

Authorization
string
header
requerido

Un token bearer de OAuth 2.0, enviado como Authorization: Bearer <token>. Esta es la forma recomendada de autenticación.

Obtén el token intercambiando el par de claves de acceso de una cuenta de servicio en POST /v1/oauth/token con grant_type=client_credentials. Es el flujo estándar de credenciales de cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar el token por ti.

Los tokens duran una hora por defecto. El mismo par de claves de acceso también sirve como credencial AWS SigV4 para el endpoint de objetos compatible con S3, que solo acepta ese método de autenticación.

Parámetros de ruta

invoice_id
string<uuid>
requerido

Respuesta

La factura, incluyendo el uso y las líneas de crédito.

crn
string
requerido

Identidad de factura de ámbito de organización global.

Ejemplo:

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

id
string<uuid>
requerido
invoice_number
string
requerido
Ejemplo:

"INV-2026-000042"

period_start
string<date>
requerido

Primer día del mes de facturación UTC.

Ejemplo:

"2026-06-01"

period_end
string<date>
requerido

Fin exclusivo (primer día del mes siguiente).

Ejemplo:

"2026-07-01"

subtotal
string
requerido
Ejemplo:

"128.40"

credits_applied
string
requerido
Ejemplo:

"20.00"

total
string
requerido
Ejemplo:

"108.40"

currency
string
requerido
Ejemplo:

"BRL"

refunded_amount
string
requerido

Reembolsos confirmados menos revocaciones de reembolso fallidas, en BRL.

Ejemplo:

"25.00"

disputed_amount
string
requerido

Principal de la disputa retirado menos fondos restablecidos; excluye las tarifas del proveedor.

Ejemplo:

"0.00"

status
enum<string>
requerido
Opciones disponibles:
open,
paid,
past_due,
uncollectible,
void
created_at
string<date-time>
requerido
issued_at
string<date-time> | null
due_at
string<date-time> | null
paid_at
string<date-time> | null
pdf_url
string

Ruta del estado de cuenta PDF, generado bajo demanda por GET /v1/invoices/{invoice_id}/pdf bajo la misma autorización que este documento.

Ejemplo:

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

items
object[]

Elementos de línea; presentes solo en el extremo de detalle.