Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Gerenciar mudanças de plano

Atualizar ou fazer downgrade de um aplicativo do GitHub Marketplace aciona o webook do marketplace_purchase event com a ação alterado, que dá início ao fluxo de atualização ou downgrade.

Neste artigo

Para obter mais informações sobre atualização e downgrade com relação à cobrança, consulte "Integração com a API do GitHub Marketplace".

Etapa 1. Evento de mudança de plano de preços

O GitHub envia o webhook marketplace_purchase com a ação alterado para o seu aplicativo, quando um cliente faz qualquer uma dessas alterações no seu pedido do GitHub Marketplace:

  • Faz a atualização para um plano de preços mais caro ou para um plano de preços mais barato.
  • Adiciona ou remove estações para seu plano existente.
  • Altera o ciclo de cobrança.

O GitHub enviará o webhook quando a alteração entrar em vigor. Por exemplo, quando um cliente faz o downgrade de um plano, o GitHub envia o webhook no final do ciclo de cobrança do cliente. O GitHub envia um webhook para o seu aplicativo imediatamente quando um cliente atualiza seu plano para permitir que acesse o novo serviço imediatamente. Se um cliente mudar de um ciclo de cobrança mensal para anual, isso é considerado uma atualização. Consulte "Cobrança de clientes no GitHub Marketplace" para saber mais sobre quais ações são consideradas um atualização ou downgrade.

Leia o effective_date, marketplace_purchase e precedous_marketplace_purchase do webhook marketplace_purchase para atualizar a data de início do plano e fazer alterações no ciclo de cobrança do cliente e no plano de preços. Consulte " eventos de webhook de GitHub Marketplacepara obter um exemplo da carga de evento marketplace_purchase.

Se seu aplicativo oferecer testes grátis, você receberá o webhook marketplace_purchase com a ação alterado quando o teste grátis expirar. Se o teste grátis do cliente expirar, faça a atualização do cliente para a versão paga do plano grátis de teste.

Etapa 2. Atualizar as contas dos clientes

Você precisará atualizar as informações da conta do cliente para refletir as alterações no ciclo de cobrança e no plano de preços que o cliente fez em seu pedido do GitHub Marketplace. Exibe as atualizações para o plano de preços, seat_count (para planos de preços por unidade) e ciclo de cobrança no site do aplicativo do Marketplace ou na interface do usuário do seu aplicativo quando você receber a ação de webhook alterado.

Quando um cliente faz o downgrade de um plano, recomenda-se revisar se o cliente excedeu os limites do seu plano e interagir diretamente com ele na sua interface de usuário ou entrando em contato por telefone ou e-mail.

Para incentivar as pessoas a fazer a atualização, você pode exibir uma URL de upgrade na interface do usuário do seu aplicativo. Consulte "Sobre as URLs de atualização" para obter mais detalhes.

Observação: Recomendamos executar uma sincronização periódica usando GET /marketplace_listing/plans/:id/accounts para garantir que seu aplicativo tenha o plano, as informações do ciclo de cobrança e a contagem de unidades (preço por unidade) corretos para cada conta.

Falha nos pagamentos de atualização

No caso em que um cliente atualiza seu plano e o pagamento falhar, o GitHub reverte sua assinatura de GitHub Marketplace ao seu estado anterior. O GitHub também envia um e-mail ao cliente para informá-lo sobre a falha e permitir que ele tente novamente sua compra. Você receberá um webhook com a ação changed (alterada) solicitando que você reverta para o plano anterior.

Sobre as URLs de atualização

Você pode redirecionar os usuários da interface de usuário do seu aplicativo no GitHub, usando uma URL de atualização:

https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>

Por exemplo, se você notar que um cliente está em um plano de 5 pessoas e precisa passar para um plano de 10 pessoas, você poderia exibir um botão na interface do usuário do seu aplicativo que diz "Aqui está como atualizar" ou exibir um banner com um link para a URL de atualização. A URL atualização leva o cliente para a página de confirmação de confirmação da atualização do seu plano da listagem.

Use o LISTING_PLAN_NUMBER para o plano que o cliente gostaria de comprar. Ao criar novos planos de preços, eles recebem um LISTING_PLAN_NUMBER, que é exclusivo para cada plano na sua listagem, e um LISTING_PLAN_ID, que é exclusivo para cada plano no GitHub Marketplace. Você pode encontrar esses números ao Listar planos, que identifica os seus planos de preços da listagem. Use o LISTING_PLAN_ID e "Listar contas de um plano" para obter o CUSTOMER_ACCOUNT_ID.

Observação: Se seu cliente atualiza unidades adicionais (como estações), você ainda poderá enviá-las para o plano apropriado para a compra, mas não podemos suportar os parâmetros de unit_count neste momento.

Esse documento ajudou você?

Privacy policy

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.