> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upag.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Payload — Invoice
> Estrutura do objeto data nos webhooks de fatura
Quando o evento é do tipo `invoice.*`, o campo `data` da requisição de webhook contém um objeto fatura no formato abaixo.
## Estrutura
```json theme={null}
{
"id": "inv_xyz789abc",
"livemode": false,
"customer": "cus_ahwDXrgYvur89iPs",
"paymentMethod": "pm_abc123xyz",
"status": "open",
"currency": "BRL",
"createdAt": 1731622178441,
"updatedAt": 1731622178441,
"canceledAt": null,
"items": [
{
"id": "ii_abc123",
"product": "prod_xyz",
"price": "pri_xyz",
"name": "Plano Mensal",
"amount": 9900,
"quantity": 1
}
]
}
```
## Atributos
```json {2} theme={null}
{
"id": "inv_xyz789abc",
}
```
`id` : string.
Identificador único da fatura, começando com `inv_`
```json {2} theme={null}
{
"livemode": false,
}
```
`livemode` : boolean.
Indica se a fatura está em modo de produção (`true`) ou teste (`false`)
```json {2} theme={null}
{
"customer": "cus_ahwDXrgYvur89iPs",
}
```
`customer` : string.
ID do cliente, começando com `cus_`
```json {2} theme={null}
{
"paymentMethod": "pm_abc123xyz",
}
```
`paymentMethod` : string.
ID do método de pagamento, começando com `pm_`
```json {2} theme={null}
{
"status": "open",
}
```
`status` : string.
Status atual da fatura (ex.: `draft`, `open`, `paid`, `void`)
```json {2} theme={null}
{
"currency": "BRL",
}
```
`currency` : string.
Código da moeda (ex.: `BRL`)
```json {2} theme={null}
{
"createdAt": 1731622178441,
}
```
`createdAt` : number.
Timestamp Unix de criação da fatura
```json {2} theme={null}
{
"updatedAt": 1731622178441,
}
```
`updatedAt` : number.
Timestamp Unix da última atualização
```json {2} theme={null}
{
"canceledAt": null,
}
```
`canceledAt` : number | null.
Timestamp Unix do cancelamento da fatura. Pode ser `null`
```json {2-12} theme={null}
{
"items": [
{
"id": "ii_abc123",
"product": "prod_xyz",
"price": "pri_xyz",
"name": "Plano Mensal",
"amount": 9900,
"quantity": 1
}
]
}
```
`items` : array.
Lista de itens da fatura. Cada item contém: `id` (string, prefixo `ii_`), `product` (ID do produto), `price` (ID do preço), `name`, `amount` (centavos), `quantity`