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.

Retorna uma lista paginada de todas as faturas. Pode ser filtrada por cliente ou status.

​
Endpoint

cURL
curl -G https://api.upag.io/v1/invoices \
  -H "Authorization: Bearer {token}" \
  -d page=1 \
  -d limit=10 \
  -d customer=cus_ahwDXrgYvur89iPs

​
Parâmetros

​
limit
integer
Limita o número de faturas retornadas. Padrão: 10, máximo: 100.
​
page
integer
Número da página a ser retornada. Padrão: 1.
​
id
string
Filtra por ID da fatura (inv_...).
​
customer
string
ID do cliente (cus_...) para filtrar faturas desse cliente. O parâmetro na query é customer, não customerId.
​
status
string
Filtra faturas por status: draft, open, paid, uncollectible, void.

​
Resposta

Response
{
  "data": [
    {
      "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": 1,
      "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"
    }
  ],
  "total": 1
}