Cancelar assinaturas

Este guia descreve como usar a API Subscription ou o Dashboard para gerenciar assinaturas de clientes.

Se quiser manter uma assinatura ativa, mas interromper temporariamente o recebimento de pagamentos, você pode suspender a cobrança de pagamentos. Suspender a coleta de pagamentos não afeta o status da assinatura, que recomendamos usar como o acionador para iniciar ou interromper o serviço ao seu cliente.

As assinaturas são canceladas automaticamente depois de até oito tentativas malsucedidas de cobrar o cliente. Você pode configurar o número de tentativas nas configurações do ciclo de vida da assinatura. Saiba mais sobre as configurações de recuperação de receitas, como Smart Retries e e-mails configuráveis para clientes.

Cancelar assinaturas

Você pode cancelar as assinaturas dos clientes manualmente com a API ou no Dashboard. Por padrão, o cancelamento entra em vigor imediatamente e as faturas não são mais geradas para assinaturas canceladas. Após o cancelamento, você não poderá mais atualizar a assinatura ou seus metadados.

Ratear para faturamento por uso

Quando uma assinatura já consumiu parte de um período de faturamento pago, você pode ratear o cancelamento passando o parâmetro prorate.

Quanto um cancelamento é rateado, você tem a opção de emitir uma fatura para:

• Rateamentos pendentes
• Uso medido

Se você não ratear a assinatura, todo o uso medido será descartado e o cliente não receberá crédito por possíveis rateios.

Crie uma fatura final imediatamente usando o parâmetro invoice_now. Se você deve um crédito ao cliente após o cancelamento, é possível adicionar o crédito ao saldo de crédito do cliente para aplicar a faturas futuras. Para reembolsar um cliente, emita reembolsos e ajuste o saldo da conta para zero.

Cancelar ao final do ciclo de faturamento atual

Para cancelar uma assinatura no final do período de faturamento atual, defina cancel_at_period_end como true:

curl https://api.stripe.com/v1/subscriptions/
{{SUBSCRIPTION_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d cancel_at_period_end=true

Isso permite que a assinatura conclua o período já pago pelo cliente. Você pode reativar assinaturas agendadas para cancelamento, atualizando cancel_at_period_end para false. Você pode reativar a assinatura a qualquer momento até o final do período.

Cancelar após alterações agendadas ou em ciclos de faturamento futuros

Para agendar o término de uma assinatura após um número específico de ciclos de faturamento, crie um cronograma de assinatura. Defina a duração do cronograma especificando uma ou mais fases e intervalos e defina seu atributo end_behavior como cancel.

Com um comportamento final de cancel, os cronogramas de assinatura gerenciam automaticamente o atributo cancel_at da assinatura. Quando o cronograma está em sua última fase, a data de cancelamento da assinatura é definida como a data de término da fase. Caso contrário, a data de cancelamento não é definida na assinatura.

Por isso, adicionar uma nova fase a um cronograma que está em sua última fase remove a data de cancelamento. Se a assinatura estiver no último período de faturamento quando a data de cancelamento for prorrogada ou removida, as âncoras de término do período e de ciclo de faturamento podem ser alteradas. Veja como definir uma data de cancelamento personalizada para obter mais detalhes.

Configurar cancelamento automático após uma contestação

Quando um cliente contesta uma cobrança de uma assinatura, a assinatura continua o ciclo, o que pode criar mais cobranças contestadas. Você pode alterar esse comportamento no Dashboard para cancelar assinaturas. As alterações na assinatura entram em vigor após aproximadamente uma hora.

Em Gerenciar pagamentos contestados, selecione uma das seguintes opções:

• cancelar a assinatura imediatamente sem qualquer cobrança proporcional — A assinatura é cancelada imediatamente sem qualquer cobrança proporcional. Não é possível reiniciar uma assinatura cancelada. Você precisa criar uma assinatura para o cliente se quiser continuar a cobrá-lo.

• cancelar a assinatura ao final do período – A assinatura é cancelada ao final do período de faturamento atual e cancel_at_period_end é definido como true. Isso permite que você trabalhe no processo de contestação antes do cancelamento.

Assinaturas gerenciadas com cronogramas são removidas do cronograma e então canceladas. Isso significa que as demais alterações agendadas não serão aplicadas.

Processar itens de fatura ao cancelar assinaturas

Seu cliente ainda pode ser cobrado por itens de fatura pendentes em uma assinatura nos seguintes casos:

• O cancelamento da assinatura inclui uma fatura final
• Seu cliente tem outra assinatura ativa

Para evitar cobrar o cliente por itens de fatura pendentes, exclua manualmente os itens da fatura.

Da mesma forma, qualqueruso relatado durante o período de faturamento é faturado no final do período. Para evitar uma cobrança final pelo uso, use o parâmetro clear_usage para atualizar a assinatura e remover o preço por consumo.

Se o cancelamento da assinatura for definido para o final do período, todas as cobranças proporcionais pendentes continuarão ativas e serão cobradas no final do período. Se a assinatura for cancelada antes do final do período, os itens da fatura permanecerão e só serão processados se incluídos em uma fatura.

Quando você cancela uma assinatura, todas as faturas open e draft dessa assinatura têm a propriedade auto_advance definida como false. Isso interrompe a cobrança automática dessas faturas e evita o envio de e-mails de lembretes automáticos. Você ainda pode tentar receber pagamentos e enviar e-mails manualmente.

Identificar eventos de cancelamento

A Stripe envia os eventos a seguir para assinaturas canceladas.

Interromper um cancelamento pendente

Você pode interromper um cancelamento agendado usando a API Update Subscription ou o Dashboard. Não é possível reativar uma assinatura cancelada.

Definir uma data de cancelamento personalizada

Use o parâmetro cancel_at para cancelar uma assinatura em um carimbo de data e hora futuro.

curl https://api.stripe.com/v1/subscriptions/
{{SUBSCRIPTION_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d cancel_at=1723766400

Quando você agenda uma data de cancelamento antes do final do período de cobrança, a current_period_end dos itens da assinatura é atualizada para corresponder à data cancel_at. Isso cria cobranças proporcionais para a mudança no período atual, a menos que sua atualização desative cobranças proporcionais.

Para assinaturas que usam billing_mode, você pode usar auxiliares de enumeração com o parâmetro cancel_at para simplificar o cancelamento de uma assinatura no final de um período de cobrança. Os auxiliares min_period_end e max_period_end permitem especificar quando cancelar uma assinatura com base nos períodos de cobrança de todos os itens de assinatura.

Esses auxiliares resolvem imediatamente os carimbos de data/hora, reduzindo o risco de alterações posteriores no current_period_end de um item afetarem o carimbo de data e hora de cancelamento resolvido.

Se você agendar uma data de cancelamento que ocorra em mais de um período no futuro, o ciclo da assinatura permanecerá inalterado até que a assinatura seja renovada para o período que contém a data cancel_at. O items.current_period_end da renovação é encurtado para corresponder à data cancel_at.

Por exemplo, seu cliente iniciar uma assinatura licenciada de US$ 120 por ano que será renovada em 1º de janeiro de 2024. O cancelamento da assinatura foi definido para 1º de julho de 2024. O subtotal final da fatura em 1º de janeiro é calculado como US$ 60, e o items.current_period_end é 1º de julho.

Alterar, adicionar ou remover uma data de cancelamento agendada dentro do período atual atualiza o items.current_period_end e cria cobranças proporcionais. No exemplo acima, em 15 de fevereiro, você atualiza a data de cancelamento para 1º de outubro. O término do período atual se torna 1º de outubro, e a Stripe cria cobranças proporcionais de US$ 30 para o trimestre adicional. Para faturar os itens proporcionais imediatamente e não na fatura final em 1º de outubro, passe um proration_behavior de always_invoice na atualização ou crie uma fatura avulsa separadamente.

Cancelamento com âncora de ciclo de cobrança

A propriedade âncora do ciclo de cobrança da assinatura pode ser alterada se ela tiver acompanhado a data de cancelamento anterior. Durante o primeiro período, a Stripe preserva qualquer âncora que você tiver definido originalmente na assinatura. Quando o primeiro período termina, ou se você não forneceu uma âncora personalizada ao criar a assinatura, a âncora é redefinida para o início do período atual. Esse comportamento de redefinição da âncora do ciclo de cobrança só é garantido para assinaturas criadas após junho de 2024. As assinaturas criadas antes dessa data podem apresentar o comportamento herdado: a propriedade âncora do ciclo de cobrança permanece inalterada após cancelamento, remoção ou prorrogação.

Adicionar uma data de cancelamento ou mudar uma data para mais perto do horário atual reduz a âncora do ciclo de faturamento para corresponder à nova data de cancelamento. No exemplo acima, em 15 de fevereiro, você atualiza a data de cancelamento para 1º de abril. O término do período e a âncora de faturamento tornam-se 1º de abril e a Stripe cria cobranças proporcionais de -30 USD para creditar o tempo não utilizado de 1º de abril a 1º de julho.