Skip to main content

Cobrar dos clientes

Os aplicativos no GitHub Marketplace devem aderir às diretrizes de cobrança do GitHub e oferecer suporte aos serviços recomendados. A observância das nossas diretrizes ajuda os clientes a percorrer o processo de cobrança sem nenhuma surpresa.

Entender o ciclo de cobrança

Os clientes podem escolher um ciclo de cobrança mensal ou anual quando ao comprar seu aplicativo. Todas as alterações feitas pelos clientes no período de cobrança e na seleção do plano vão disparar um evento marketplace_purchase. Veja a carga de webhook marketplace_purchase para ver o período de cobrança que um cliente seleciona e o início da próxima data de cobrança (effective_date). Para obter mais informações sobre cargas de webhook, confira "Eventos de webhook para a API do GitHub Marketplace".

Fornecer serviços de cobrança na interface de usuário do seu aplicativo

Os clientes devem ser capazes de executar as seguintes ações no site do seu aplicativo:

  • Os clientes devem ser capazes de modificar ou cancelar seus planos de GitHub Marketplace para contas pessoais e organizacionais separadamente.
  • Os clientes que cancelarem um plano pago comprado em GitHub Marketplace devem ser automaticamente rebaixados para o plano gratuito do aplicativo, se houver. Quando um cliente cancela uma assinatura do GitHub Marketplace, o GitHub não desinstala automaticamente o aplicativo, então o cliente pode esperar que os recursos gratuitos continuem funcionando. é altamente recomendável permitir que os clientes reativem seu plano anterior.
  • Os clientes conseguirão fazer o upgrade por meio da interface do usuário do aplicativo se você fornecer uma URL de upgrade neste formato: https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>
  • Os clientes devem ser capazes de modificar quais usuários têm acesso ao seu aplicativo a partir do site do seu aplicativo, caso tenham comprado assentos (por plano de preços unitários) ou que o plano ofereça colaboradores ilimitados.
  • Os clientes devem poder ver as seguintes alterações em sua conta imediatamente na cobrança, perfil ou seção de configurações de conta do site:
    • Plano e preço atuais.
    • Novos planos comprados.
    • Upgrades, downgrades, cancelamentos e o número de dias restantes em uma avaliação gratuita.
    • Alterações nos ciclos de faturamento (mensal ou anual).
    • Uso e recursos restantes para planos fixos e por unidade. Por exemplo, se o plano de preços é por unidade, o site do aplicativo deve mostrar unidades usadas e unidades disponíveis.

Os serviços de cobrança para upgrade, downgrade e cancelamentos

Siga estas diretrizes para upgrades, downgrade e cancelamentos para manter um processo de cobrança claro e consistente. Para obter instruções mais detalhadas sobre os eventos de compra do GitHub Marketplace, confira "Como usar a API do GitHub Marketplace no seu aplicativo".

Use a chave marketplace_purchase do webhook effective_date para determinar quando uma alteração de plano ocorrerá e sincronizar Listar as contas de um plano periodicamente.

Atualizações

Quando um cliente atualiza seu plano de preços ou altera seu ciclo de cobrança de mensal para anual, você deve implementar mudança imediatamente para este cliente. Você precisa aplicar um desconto proporcional ao novo plano e alterar o ciclo de cobrança.

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 solicitando que você reverta para o plano anterior.

Para obter informações sobre como criar fluxos de trabalho de upgrade e downgrade no seu aplicativo, confira "Como processar alterações de plano".

Downgrades e cancelamentos

Os downgrades ocorrem quando um cliente muda de um plano pago para um plano gratuito, seleciona um plano com um custo menor que o seu plano atual, ou muda seu ciclo de cobrança de anual para mensal. Quando ocorre o downgrade ou cancelamento, você não precisa fornecer um reembolso. Em vez disso, o plano atual permanecerá ativo até o último dia do ciclo de cobrança atual. O evento marketplace_purchase será enviado quando o novo plano entrar em vigor no início do próximo período de cobrança do cliente.

Quando um cliente cancela um plano, você deve:

  • Fazer o downgrade automaticamente para o plano grátis, caso exista.

    Quando um cliente cancela uma assinatura do GitHub Marketplace, o GitHub não desinstala automaticamente o aplicativo, então o cliente pode esperar que os recursos gratuitos continuem funcionando.

  • Habilitá-los para atualizar o plano por meio do GitHub, caso desejem continuar o plano mais adiante.

Para obter informações sobre como criar fluxos de trabalho de cancelamento no seu aplicativo, confira "Como processar cancelamentos de plano".