Skip to main content
Remove um item da subscription. Remover um item não cancela a subscription, mas a subscription precisa continuar com pelo menos um item ativo.
​
string
required
ID do item (si_*).
​
string
Como o crédito pró-rata da remoção é faturado. Padrão: create_prorations.
  • create_prorations (padrão) — calcula o crédito proporcional do tempo não usado e o lança como item pendente, abatido na próxima invoice do ciclo.
  • always_invoice — calcula o crédito e emite uma invoice de update imediatamente, aplicando o saldo resultante.
  • none — remove o item sem crédito proporcional; a remoção vale a partir da próxima renovação.
​
string
Define o que acontece quando a remoção gera uma cobrança imediata (invoice de update criada por proration_behavior: "always_invoice" com valor a cobrar). Padrão: allow_incomplete.
  • allow_incomplete (padrão) — aplica a remoção na hora e tenta cobrar a invoice de update automaticamente; se a cobrança falhar, a remoção permanece aplicada e a invoice segue a régua de retentativas.
  • default_incomplete — aplica a remoção e cria a invoice com o payment_intent, mas não tenta a cobrança automaticamente.
  • pending_if_incomplete — retém a remoção em pending_update na subscription até a invoice de update ser paga; se expirar sem pagamento, a remoção é descartada. Exige collection_method: "charge_automatically".
  • error_if_incomplete — recusa a remoção com erro 402 se ela geraria cobrança imediata com valor devido; nada é alterado.
​
string
Timestamp ISO 8601 usado para calcular o pró-rata.