Skip to main content
Mudanças agendadas representam alterações em itens de uma assinatura que entrarão em vigor no próximo período de cobrança. Por exemplo, ao atualizar o plano de um cliente, a mudança pode ser agendada para não interromper o ciclo atual.

​
Listar Mudanças Agendadas

cURL
curl https://api.upag.io/v1/subscriptions/sub_abc123xyz/scheduled-changes \
  -H "Authorization: Bearer {token}"

​
Parâmetros — Listar

​
subscriptionId
string
required
ID único da assinatura, começando com sub_.

​
Resposta — Listar

Response
{
  "data": [
    {
      "id": "sc_abc123xyz",
      "subscriptionId": "sub_abc123xyz",
      "operation": "add",
      "itemId": "si_abc123xyz",
      "priceId": "price_ghi789jkl",
      "quantity": 1,
      "createdAt": "2024-11-15T10:00:00.000Z"
    }
  ],
  "total": 1
}

​
Cancelar Mudança Agendada

Remove uma mudança agendada antes que ela entre em vigor.
cURL
curl -X DELETE https://api.upag.io/v1/subscriptions/sub_abc123xyz/scheduled-changes/sc_abc123xyz \
  -H "Authorization: Bearer {token}"

​
Parâmetros — Cancelar

​
subscriptionId
string
required
ID único da assinatura, começando com sub_.
​
id
string
required
ID único da mudança agendada, começando com sc_.

​
Resposta — Cancelar

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