Itens da Assinatura

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.billing.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

string

required

ID único da assinatura, começando com sub_.

string

required

ID do preço (price_...) a ser adicionado.

integer

required

Quantidade (inteiro, mínimo 1).

string

Opcional. now (padrão) ou period_end para aplicar na renovação.

Resposta — Adicionar Item

201 Created — item imediato (applyAt: now):

Response

{
  "id": "si_abc123xyz",
  "subscriptionId": "sub_abc123xyz",
  "productId": "prod_xyz789abc",
  "priceId": "price_def456ghi",
  "name": "Plano Pro",
  "amount": 9900,
  "quantity": 1,
  "createdAt": "2024-11-15T10:00:00.000Z",
  "updatedAt": "2024-11-15T10:00:00.000Z"
}

Com applyAt: period_end, a resposta pode ser uma mudança agendada (mesmo formato de Mudanças agendadas).

Atualizar Item

cURL

curl -X PUT https://api.billing.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

string

required

ID único da assinatura, começando com sub_.

string

required

ID único do item da assinatura, começando com si_.

integer

Nova quantidade (opcional se price for enviado).

string

Novo ID de preço (opcional se quantity for enviado).

string

Opcional. now ou period_end.

Resposta — Atualizar Item

200 OK — item atualizado:

Response

{
  "id": "si_abc123xyz",
  "subscriptionId": "sub_abc123xyz",
  "productId": "prod_xyz789abc",
  "priceId": "price_def456ghi",
  "name": "Plano Pro",
  "amount": 9900,
  "quantity": 2,
  "createdAt": "2024-11-15T10:00:00.000Z",
  "updatedAt": "2024-11-16T10:00:00.000Z"
}

Remover Item

applyAt é lido da query string (req.query), não do body.

cURL

curl -X DELETE "https://api.billing.upag.io/v1/subscriptions/sub_abc123xyz/items/si_abc123xyz?applyAt=now" \
  -H "Authorization: Bearer {token}"

Parâmetros — Remover Item

string

required

ID único da assinatura, começando com sub_.

string

required

ID único do item da assinatura, começando com si_.

string

Opcional. now (padrão) ou period_end.

Resposta — Remover Item

204 No Content quando a remoção é imediata (sem corpo). Com applyAt=period_end, 200 OK com mudança agendada:

Response

{
  "id": "sc_abc123xyz",
  "subscriptionId": "sub_abc123xyz",
  "operation": "remove",
  "itemId": "si_abc123xyz",
  "priceId": "price_def456ghi",
  "quantity": 1,
  "createdAt": "2024-11-15T10:00:00.000Z"
}

Clientes

Métodos de Pagamento

Pagamentos

Sessões de Checkout

Faturas

Assinaturas

Adicionar Item

Parâmetros — Adicionar Item

Resposta — Adicionar Item

Atualizar Item

Parâmetros — Atualizar Item

Resposta — Atualizar Item

Remover Item

Parâmetros — Remover Item

Resposta — Remover Item

​Adicionar Item

​Parâmetros — Adicionar Item

​Resposta — Adicionar Item

​Atualizar Item

​Parâmetros — Atualizar Item

​Resposta — Atualizar Item

​Remover Item

​Parâmetros — Remover Item

​Resposta — Remover Item

Adicionar Item

Parâmetros — Adicionar Item

Resposta — Adicionar Item

Atualizar Item

Parâmetros — Atualizar Item

Resposta — Atualizar Item

Remover Item

Parâmetros — Remover Item

Resposta — Remover Item