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.

Os itens de uma fatura representam os produtos ou serviços cobrados. Você pode adicionar, atualizar e remover itens em faturas com status draft.

​
Adicionar Item

cURL
curl -X POST https://api.upag.io/v1/invoices/inv_abc123xyz/items \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "priceId": "price_def456ghi",
    "quantity": 1
  }'

​
Parâmetros — Adicionar Item

​
invoiceId
string
required
ID único da fatura, começando com inv_.
​
priceId
string
required
ID do preço do produto a ser adicionado.
​
quantity
integer
required
Quantidade do item. Mínimo: 1.

​
Resposta — Adicionar Item

Response
{
  "id": "ii_abc123xyz",
  "priceId": "price_def456ghi",
  "quantity": 1,
  "amount": 9900
}

​
Atualizar Item

cURL
curl -X PUT https://api.upag.io/v1/invoices/inv_abc123xyz/items/ii_abc123xyz \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "priceId": "price_def456ghi",
    "quantity": 2
  }'

​
Parâmetros — Atualizar Item

​
invoiceId
string
required
ID único da fatura, começando com inv_.
​
itemId
string
required
ID único do item da fatura, começando com ii_.
​
priceId
string
required
ID do preço do item (obrigatório no body junto com quantity).
​
quantity
integer
required
Nova quantidade do item.

​
Resposta — Atualizar Item

Response
{
  "id": "ii_abc123xyz",
  "priceId": "price_def456ghi",
  "quantity": 2,
  "amount": 9900
}

​
Remover Item

cURL
curl -X DELETE https://api.upag.io/v1/invoices/inv_abc123xyz/items/ii_abc123xyz \
  -H "Authorization: Bearer {token}"

​
Parâmetros — Remover Item

​
invoiceId
string
required
ID único da fatura, começando com inv_.
​
itemId
string
required
ID único do item da fatura, começando com ii_.

​
Resposta — Remover Item

Response
{
  "id": "ii_abc123xyz",
  "deleted": true
}