Skip to main content
Os itens de uma assinatura representam os produtos ou serviços cobrados recorrentemente. Dependendo de applyAt, a alteração pode ser imediata ou virar uma mudança agendada (resposta com objeto de scheduled change em vez do item).

​
Adicionar Item

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

​
Parâmetros — Adicionar Item

​
subscriptionId
string
required
ID único da assinatura, começando com sub_.
​
price
string
required
ID do preço (price_...) a ser adicionado.
​
quantity
integer
required
Quantidade (inteiro, mínimo 1).
​
applyAt
string
Opcional. now (padrão) ou period_end para aplicar na renovação.

​
Resposta — Adicionar Item

201 com o item criado ou com uma mudança agendada, conforme a regra de negócio. Quando for o item, o formato segue o recurso de item da assinatura (ex.: id, subscriptionId, productId, priceId, quantity, etc.).

​
Atualizar Item

cURL
curl -X PUT https://api.upag.io/v1/subscriptions/sub_abc123xyz/items/si_abc123xyz \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 2,
    "applyAt": "now"
  }'
É obrigatório enviar pelo menos um de price ou quantity.

​
Parâmetros — Atualizar Item

​
subscriptionId
string
required
ID único da assinatura, começando com sub_.
​
id
string
required
ID único do item da assinatura, começando com si_.
​
quantity
integer
Nova quantidade (opcional se price for enviado).
​
price
string
Novo ID de preço (opcional se quantity for enviado).
​
applyAt
string
Opcional. now ou period_end.

​
Resposta — Atualizar Item

200 com o item atualizado ou com mudança agendada, no mesmo sentido do POST.

​
Remover Item

applyAt é lido da query string (req.query), não do body.
cURL
curl -X DELETE "https://api.upag.io/v1/subscriptions/sub_abc123xyz/items/si_abc123xyz?applyAt=now" \
  -H "Authorization: Bearer {token}"

​
Parâmetros — Remover Item

​
subscriptionId
string
required
ID único da assinatura, começando com sub_.
​
id
string
required
ID único do item da assinatura, começando com si_.
​
applyAt
string
Opcional. now (padrão) ou period_end.

​
Resposta — Remover Item

204 No Content quando a remoção é imediata, ou 200 com objeto de mudança agendada quando aplicável.