Skip to main content
PATCH
Esta rota conclui a desativação de um plano. Ela recebe o confirmationToken devolvido por Alterar status do plano e, se o token for válido, o plano passa a inactive e deixa de aceitar novas assinaturas. A confirmação vale para qualquer desativação, tenha o plano assinaturas ativas ou não. As duas etapas existem para evitar que um plano seja tirado de venda por engano.

Quando usar

Antes de chamar

  • Tenha uma chave secreta gerada por usuário com a permissão atualizar assinaturas. Nos perfis padrão, são Owner, Manager e Operador. Os perfis Visualizador, Desenvolvedor e Financeiro recebem 403 (veja Permissões por perfil).
  • Tenha o confirmationToken devolvido por PATCH /v1/subscription-plans/{id}/status para o mesmo plano.
Assinaturas não têm modo de teste: as cobranças são reais mesmo com a chave de teste. Veja como homologar em Assinaturas: visão geral.
O token de confirmação vale por 5 minutos e é de uso único. Pedir a desativação de novo gera outro token e invalida o anterior. Com token vencido, já usado ou substituído, a chamada falha com 400 e é preciso pedir a desativação de novo.

Parâmetros de caminho

string
required
Identificador único do plano. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.

Corpo da requisição

string
required
Token recebido na rota de alteração de status. Ex.: abc123xyz.

Respostas

A resposta de sucesso não tem corpo. Para conferir o novo status, consulte o plano em Consultar plano.
Para o negócio: depois da confirmação, o plano some das opções de venda, mas as assinaturas existentes continuam ativas e renovando a cada ciclo. Desativar um plano não gera estorno nem cancelamento para ninguém. Para encerrar as assinaturas, é preciso cancelar uma a uma.

Erros comuns

Veja também

Planos

Recorrência, trial e status do plano.

Visão geral de assinaturas

Fluxo completo, do cliente à cobrança recorrente.

Ciclo de vida

Status, renovação, retentativas e cancelamento.

Webhooks de assinatura

Eventos enviados a cada etapa da assinatura.

Registrar cartão

Guarde o cartão no cofre antes de criar a assinatura.

Alterar status do plano

Primeira etapa: peça a desativação e receba o token.