Skip to main content

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.

Uma fatura representa uma cobrança emitida para um cliente. Faturas podem ser criadas manualmente ou geradas automaticamente por assinaturas.

​
Estrutura

Uma fatura é representada em nossa API pela seguinte estrutura: 
{
  "id": "inv_abc123xyz",
  "customerId": "cus_ahwDXrgYvur89iPs",
  "paymentMethodId": "pm_abc123xyz",
  "currency": "BRL",
  "status": "open",
  "livemode": false,
  "number": "INV-001",
  "description": null,
  "dueDate": "2024-12-15T00:00:00.000Z",
  "paidAt": null,
  "amountDue": 9900,
  "amountPaid": 0,
  "attemptCount": 0,
  "subscriptionId": null,
  "items": [
    {
      "id": "ii_abc123xyz",
      "priceId": "price_def456ghi",
      "quantity": 1,
      "amount": 9900
    }
  ],
  "payments": [],
  "createdAt": "2024-11-15T10:00:00.000Z",
  "updatedAt": "2024-11-15T10:00:00.000Z"
}

​
Atributos:

{
  "id": "inv_abc123xyz",
}
id : string.
Identificador único da fatura, começando com inv_
{
  "livemode": false,
}
livemode : boolean.
Indica se a fatura está em modo de produção (true) ou teste (false)
{
  "customerId": "cus_ahwDXrgYvur89iPs",
}
customerId : string.
ID do cliente associado à fatura. Veja a referência completa aqui
{
  "paymentMethodId": "pm_abc123xyz",
}
paymentMethodId : string | null.
ID do método de pagamento utilizado. Veja a referência completa aqui
{
  "status": "open",
}
status : string.
Status atual da fatura
StatusDescrição
draftA fatura está em rascunho
openA fatura foi emitida e aguarda pagamento
paidA fatura foi paga
uncollectibleA fatura não pode ser cobrada
voidA fatura foi cancelada
{
  "currency": "BRL",
}
currency : string.
Código da moeda (ex.: BRL)
{
  "number": "INV-001",
}
number : string | null.
Número sequencial da fatura gerado automaticamente ao ser emitida
{
  "description": null,
}
description : string | null.
Descrição interna da fatura
{
  "dueDate": "2024-12-15T00:00:00.000Z",
}
dueDate : string | null.
Data de vencimento da fatura em formato ISO 8601
{
  "paidAt": null,
}
paidAt : string | null.
Data em que a fatura foi paga. null se ainda não paga
{
  "amountDue": 9900,
}
amountDue : number.
Valor total a ser cobrado em centavos
{
  "amountPaid": 0,
}
amountPaid : number.
Valor já pago em centavos
{
  "attemptCount": 0,
}
attemptCount : number.
Número de tentativas de cobrança realizadas
{
  "subscriptionId": null,
}
subscriptionId : string | null.
ID da assinatura que gerou esta fatura. null para faturas criadas manualmente
{
  "items": [
    {
      "id": "ii_abc123xyz",
      "priceId": "price_def456ghi",
      "quantity": 1,
      "amount": 9900
    }
  ]
}
items : array.
Lista de itens da fatura. Cada item contém id, priceId, quantity e amount (em centavos)
{
  "payments": [],
}
payments : array.
Lista de pagamentos associados a esta fatura
{
  "createdAt": "2024-11-15T10:00:00.000Z",
}
createdAt : string.
Data de criação da fatura em formato ISO 8601
{
  "updatedAt": "2024-11-15T10:00:00.000Z",
}
updatedAt : string.
Data da última atualização da fatura em formato ISO 8601