Skip to main content
PATCH
Esta rota abre ou fecha um plano para novas vendas. Desativar um plano impede novas assinaturas nele, sem mexer nas assinaturas que já existem: elas continuam sendo cobradas normalmente. Por segurança, a desativação sempre acontece em duas etapas, com ou sem assinaturas ativas no plano: esta rota devolve um token de confirmação e o plano só fica inativo depois de Confirmar desativação. A ativação é imediata.

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 id do plano.
  • Para desativar, prepare a aplicação para chamar a confirmação logo em seguida: o token vale por 5 minutos e só pode ser usado uma vez.
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.

Como funciona a desativação

1

Solicite a desativação

Chame esta rota com {"status": "inactive"}. A resposta traz sempre requiresConfirmation: true e um confirmationToken. Pedir a desativação de novo gera outro token e invalida o anterior.
2

Confirme em até 5 minutos

Envie o confirmationToken para PATCH /v1/subscription-plans/{id}/status/confirm. A resposta 204 indica que o plano foi desativado. O token é de uso único.
3

Confira o resultado

Consulte o plano: status passa a ser inactive. As assinaturas existentes seguem ativas e renovando normalmente. Para encerrá-las, cancele uma a uma.

Parâmetros de caminho

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

Corpo da requisição

string
required
Novo status do plano: active ou inactive. Ex.: inactive.

Respostas

A resposta 200 nunca traz o objeto do plano. O formato depende do status pedido.
boolean
true ao pedir a desativação (sempre). false ao ativar.
string
Só ao desativar. Token para Confirmar desativação. Ex.: abc123xyz. Vale por 5 minutos e é de uso único. Um novo pedido de desativação gera outro token e invalida o anterior.
Para o negócio: desativar um plano tira o produto da prateleira, mas não encerra a receita recorrente de quem já assinou. Se a intenção é descontinuar o serviço por completo, além de desativar o plano é preciso cancelar cada assinatura, considerando as regras de cancelamento (estorno automático em até 7 dias da criação da assinatura).

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.

Confirmar desativação

Segunda etapa da desativação do plano.