Skip to main content

Gerenciar cancelamento de plano

O cancelamento de um aplicativo GitHub Marketplace dispara o webhook do marketplace_purchase evento com a açãocancelled, o que inicia o fluxo de cancelamento.

Observação: este artigo se aplica somente à publicação de aplicativos do GitHub Marketplace. Para obter mais informações mais sobre como publicar o GitHub Actions no GitHub Marketplace, confira "Publicar ações no GitHub Marketplace".

Para saber mais sobre como fazer o cancelamento no que se refere à cobrança, confira " Cobrar dos clientes".

Etapa 1. Evento de cancelamento

Se um cliente optar por cancelar um pedido do GitHub Marketplace, o GitHub enviará um webhook marketplace_purchase com a ação cancelled para seu aplicativo quando o cancelamento entrar em vigor. Se o cliente efetuar o cancelamento durante um teste grátis, seu aplicativo receberá o evento imediatamente. Quando um cliente cancelar um plano pago, o cancelamento ocorrerá ao final do ciclo de cobrança do cliente.

Etapa 2. Desativar as contas dos clientes

Quando um cliente cancela um plano grátis ou pago, seu aplicativo deve realizar essas etapas para concluir o cancelamento:

  1. Desative a conta do cliente que cancelou o plano.
  2. Revogue o token do OAuth que seu aplicativo recebeu para o cliente.
  3. Se o aplicativo for um OAuth app, remova todos os webhooks que o aplicativo criou para os repositórios.
  4. Remova todos os dados do cliente no prazo de 30 dias após o recebimento do evento cancelled.

Observação: recomendamos usar a effective_date do webhook marketplace_purchase para determinar quando uma alteração de plano ocorrerá e sincronizar periodicamente Listar as contas de um plano. Para saber mais sobre webhooks, confira "Eventos do Webhook para a API do GitHub Marketplace".