Plugin de Assinaturas do Discourse

[Discourse]

	Resumo	O plugin Discourse Subscriptions permite que os proprietários do site vendam assinaturas recorrentes e de compra única que concedem acesso a um grupo em uma instância do Discourse.
	Guia de Instalação	Este plugin é incluído no núcleo do Discourse. Não é necessário instalar o plugin separadamente.

Como este é um plugin #oficial mantido pela equipe do Discourse, solicitações de Support, Contribute > Bug, Contribute > UX e Contribute > Feature podem ser feitas nas respectivas categorias aqui no Meta, e marcadas com a tag de plugin apropriada. Clique em um dos links abaixo para iniciar uma.

Suporte Bug UX Recurso

O plugin Discourse Subscriptions permite criar assinaturas de compra única e recorrentes que os usuários podem pagar para acessar conteúdo restrito. Esta pode ser uma ótima maneira de financiar os custos de hospedagem da sua comunidade.

Recursos

O plugin Discourse Subscriptions suporta os seguintes recursos:

• Criar novos produtos e planos a partir do painel administrativo
• Cancelar e reembolsar assinaturas a partir do painel administrativo
• Criar planos de assinatura de compra única ou recorrentes
• Adicionar períodos de teste gratuitos em assinaturas recorrentes
• Suporte a SCA/3D Secure
• Adicionar/remover usuários dos grupos de planos conforme eles assinam/cancelam
• Cancelar assinatura a partir do perfil do usuário
• Cancelamento da assinatura ao final do período de assinatura
• Suporte opcional ao Stripe Checkout
• Cálculo e coleta automática de imposto sobre vendas
• Os usuários podem atualizar seu cartão para assinaturas individuais

O botão “Assinar” localizado na navegação superior levará você à página de Assinatura /s, onde estão listadas as assinaturas que você configurou para o seu site:

Quando um usuário clica em um dos botões “Assinar” para um plano específico, será aberta a página de pagamento para aquele plano:

Após o usuário preencher seus detalhes de pagamento e endereço e clicar em “Assinar”, uma mensagem de “Obrigado!” é exibida e ele é levado à sua página de faturamento:

O usuário também é adicionado automaticamente a um grupo de sua escolha, para que você possa ver facilmente quais usuários se inscreveram, bem como fornecer conteúdo restrito em categorias que apenas esse grupo pode ver.

Termos

• Assinatura - As assinaturas são um plano de pagamento recorrente que permite controlar o acesso ao conteúdo na sua comunidade. Quando uma assinatura é criada ou excluída, um usuário é adicionado ou removido do grupo de usuários associado ao seu plano de assinatura. Uma assinatura é composta por um produto e planos.
• Produto - Nos termos do Stripe, um produto é o que você está vendendo. Um produto pode conter um ou mais planos.
  • Para adicionar uma descrição ao seu produto, adicione um campo de metadados chamado “description” e use esse em vez do outro. Você pode usar Markdown.
• Plano - Um plano contém um preço, um ciclo recorrente e está associado a um grupo ao qual seus assinantes ganham acesso.

Tenha muito cuidado para manter suas chaves privadas do Stripe seguras e protegidas em todo momento.

Se você desligar sua instância do Discourse, desinstalar este plugin ou seu site ficar offline, o Stripe continuará cobrando seus clientes pelo seu serviço até que a assinatura seja cancelada.

Configuração

1. Instale e ative o plugin
2. Configure o Gateway de Pagamento (Stripe)
3. Configure Webhooks e Eventos no Stripe
4. Adicione suas chaves do Stripe (pública, secreta, segredo do webhook) em Admin > Plugins > Installed > Subscriptions > Settings /admin/site_settings/category/discourse_subscriptions?filter=plugin%3Adiscourse-subscriptions.
5. Crie um grupo para seus assinantes entrarem por meio da compra
6. Crie um produto e um plano em Admin > Plugins > Subscriptions
7. Lucro!

Configure seu Gateway de Pagamento.

Primeiro, você precisará de uma conta no gateway de pagamento Stripe. Para começar, você pode configurar uma conta em modo de teste e ver como tudo funciona sem fazer transações reais ou precisar configurar uma conta bancária. Não há uma alternância para o modo de teste no plugin; em vez disso, certifique-se de usar suas chaves de desenvolvedor (elas começam com pk_test, sk_test)

Configure Webhooks e Eventos em sua conta do Stripe

Webhooks são necessários para que os cancelamentos de assinatura funcionem totalmente. Certifique-se de que eles estejam configurados corretamente.

Depois que você tiver uma conta no Stripe, precisará informar ao Stripe o endereço do seu site para que ele possa notificá-lo sobre certas transações. Você pode inserir isso no seu painel do Stripe em Endpoints > URL.

Endereço dos Webhooks: [endereço do seu servidor]/s/hooks – onde [endereço do seu servidor] é a URL da sua instalação do Discourse.

Você também precisará informar ao Stripe quais eventos ele deve notificá-lo por meio da URL do webhook.

Atualmente, o Discourse Subscriptions responde aos seguintes eventos:

• customer.subscription.deleted
• customer.subscription.updated
• checkout.session.completed
• checkout.session.async_payment_succeeded

Adicione as chaves da API e do Webhook do Stripe às configurações do seu plugin

O Stripe precisa ser autorizado a se comunicar com o seu site. Para fazer isso, ele publica um par de chaves de API privadas e públicas e um segredo de assinatura para seus webhooks.

Para autorizar webhooks, adicione as chaves da API e o segredo do webhook do Stripe à sua página de configurações (em Developers).

Adicionar chaves de produção resultará em pagamentos reais. Se você planeja testar, certifique-se de alternar para o modo View test data e obter as chaves pk_test e sk_test em Developers.

Nas configurações da sua conta do Stripe, veja:

• https://dashboard.stripe.com/apikeys
• https://dashboard.stripe.com/webhooks

Adicione essas chaves nas configurações apropriadas em Admin > Plugins > Installed > Subscriptions > Settings /admin/site_settings/category/discourse_subscriptions?filter=plugin%3Adiscourse-subscriptions.

Configure seus Grupos de Usuários no Discourse

Quando um usuário se inscreve com sucesso no seu aplicativo Discourse, após a transação do cartão de crédito ter sido processada, ele é adicionado a um Grupo de Usuários. Ao atribuir usuários a um Grupo de Usuários, você pode gerenciar a quais partes do seu site seus usuários têm acesso. Os grupos de usuários são uma funcionalidade central do Discourse e este plugin não faz nada com eles, exceto adicionar e remover usuários do grupo que você associou ao seu Plano.

Crie um ou mais produtos com planos.

Em Admin > Plugins > Subscriptions, clique para adicionar um novo Produto. Depois que você salvar um produto, poderá adicionar planos a ele. Tenha em mente que o preço e os intervalos de faturamento dos planos não podem ser alterados depois de criados. Isso é para evitar confusão no gerenciamento de assinaturas.

Se você olhar para o seu Painel do Stripe, verá que todos esses produtos e planos estão listados. O Discourse Subscriptions não os cria localmente. Eles são criados no Stripe.

Testes

Teste com estes números de cartão de crédito:

• 4242 4242 4242 4242
• 4111 1111 1111 1111 (sem autenticação necessária)
• 4000 0027 6000 3184 (autenticação necessária)

Para mais números de cartão de teste: Test card numbers | Stripe Documentation

Visite /s e insira algumas transações de teste.

Colocando em Produção

Quando você estiver pronto para colocar em produção, altere suas chaves de API e segredo do webhook para chaves de produção. Você precisará criar novos produtos e planos em modo de produção.

Esteja ciente de que, se você não configurar corretamente os webhooks do Stripe e os pagamentos recorrentes falharem por qualquer motivo (cartão de crédito expirado, etc.), os usuários ainda terão acesso ao grupo. Para que o Stripe cancele automaticamente as assinaturas, certifique-se de configurar suas configurações de Gerenciar pagamentos falhos de forma semelhante à imagem abaixo e configurar webhooks conforme descrito acima.

Atualizar Informações de Pagamento

Os usuários podem atualizar o cartão usado para assinaturas individuais visitando a página de faturamento e clicando no botão de edição ao lado da assinatura, o que abrirá esta tela:

Stripe Checkout com Tabelas de Preços do Stripe

Você também pode optar por substituir as páginas de produto e checkout do Plugin de Assinaturas e usar o Stripe Checkout com Tabelas de Preços do Stripe.

No seu Painel do Stripe:

1. Depois de ter criado os produtos no Discourse, vá para Products > Product catalog
2. Clique no produto que você deseja incluir na tabela de preços
3. Clique em Edit product
4. More Options e insira o seguinte em Metadata:
   • Chave: group_name
   • Valor: O nome do grupo no Discourse (ex.: trust_level_0)
5. Clique em Update product para salvar

Certifique-se de que o nome do grupo corresponda ao grupo selecionado em User_Groups no Discourse

Crie sua tabela de preços do Stripe

1. Vá para Products > Pricing tables
2. Crie uma nova tabela e adicione os produtos que você acabou de criar
3. Depois de publicar a tabela, copie o ID da tabela de preços encontrado dentro do código de incorporação (começa com prctbl_...)
4. Cole o ID da tabela de preços em discourse_subscriptions_pricing_table_id e ative a configuração da tabela de preços de assinaturas.
5. Clique nos sinais de verificação verdes para salvar ambas as configurações.

Etapa recomendada:

Ao configurar a Tabela de Preços dentro do Stripe, é recomendável vincular o usuário ao seu site após a conclusão do checkout, caso contrário, eles permanecerão em uma página de confirmação do Stripe sem um link de volta ao seu site.

Redirecionar para https://<seu-site>/my/billing/subscriptions é uma boa escolha para assinaturas. Para pagamentos únicos, você pode vincular diretamente para https://<seu-site>/my/billing/payments.

Coleta Automática de Impostos

Para ativar a Coleta Automática de Impostos, marque a caixa de configuração do site para discourse_subscriptions_enable_automatic_tax.

Se você ativá-lo, mas não tiver configurado sua instância do Stripe corretamente para coletar impostos, os usuários podem ver este pop-up após concluir o processo de checkout:

Há este guia para mais informações, mas não deve haver muito a fazer, pois o plugin agora está passando o parâmetro apropriado automatic_tax[enabled]=true (etapa 5).

Certifique-se de configurar seus registros (etapa 4) também:

Aqui está um exemplo de transação do Plugin de Assinatura do Discourse no Stripe mostrando que o imposto foi coletado automaticamente:

Configurações

Nome	Descrição
discourse subscriptions enabled	Ativa o plugin Discourse Subscriptions.
discourse subscriptions extra nav subscribe	Mostra o botão de assinar na navegação primária
discourse subscriptions public key	Chave Publicável do Stripe
discourse subscriptions secret key	Chave Secreta do Stripe
discourse subscriptions webhook secret	Segredo do Webhook do Stripe
discourse subscriptions currency	Código de Moeda Padrão. Isso pode ser sobrescrito ao criar um plano de assinatura.
discourse subscriptions campaign enabled	Ativa um banner de campanha para promover o apoio financeiro a esta comunidade.
discourse subscriptions campaign goal	A meta numérica para sua campanha de apoio (assinantes ou valor arrecadado).
discourse subscriptions campaign type	Seleciona o tipo de campanha a ser executada (assinantes ou valor mensal arrecadado).
discourse subscriptions campaign banner location	Seleciona a localização do banner da campanha (topo ou barra lateral).
discourse subscriptions campaign banner bg image	Envie uma imagem personalizada para usar como fundo no banner da campanha.
discourse subscriptions campaign banner shadow color	Seleciona a cor da sombra do banner da campanha.
discourse subscriptions campaign show contributors	Mostra avatares das compras mais recentes de produtos de assinatura.
discourse subscriptions campaign product	O id do produto do Stripe a enviar aos apoiadores quando eles clicarem no botão na campanha. Se esta configuração estiver em branco, os apoiadores serão direcionados para a página principal de produtos.
discourse subscriptions campaign grant	Concede ao usuário um mês gratuito de assinaturas
discourse subscriptions pricing table id	O id da tabela de preços do Stripe do código de incorporação
discourse subscriptions pricing table enabled	Ativa o uso da tabela de preços do Stripe e substitui a página de inscrição existente
discourse_subscriptions_enable_automatic_tax	Alterna se o imposto sobre vendas será coletado. Requer alguma configuração no Stripe.
discourse_subscriptions_enable_verbose_logging	Ativa um log mais detalhado para auxiliar na depuração. Por favor, não deixe permanentemente ativado em produção.

Hospedado por nós? Este plugin está disponível em nossos planos de hospedagem Pro, Business e Enterprise Subscriptions | Discourse - Civilized Discussion

[tvavrda (Tomas Vavrda)]

Configurar Sidebar parece não fazer nada (último Discourse aeb3d717dc, último plugin cc43d32a).

[tvavrda (Tomas Vavrda)]

Também estou recebendo esta mensagem de log:

Aviso de depreciação: O nome do ícone "donate" foi atualizado para "circle-dollar-to-slot". Por favor, use o novo nome em seu código. Nomes antigos serão removidos no Q2 de 2025. [deprecation id: discourse.fontawesome-6-upgrade] [info: https://meta.discourse.org/t/325349]

EDIT: Fiz um PR para isso

FIX: FontAwesome 6 compatibility icon upgrade

[blake (Blake Erickson)]

Hmmm… localmente o meu aparece na barra lateral quando eu o mudo.

Se você o tiver na barra lateral, adicionamos esta classe CSS. Você pode inspecionar sua página e procurar por subscription-campain-sidebar

Ele fica apenas no topo para você?

[tvavrda (Tomas Vavrda)]

Entendi. Eu tinha a página de Categoria como padrão. Lá não mostra, obviamente. Mostra na lista Mais Recentes. Então funciona bem. Obrigado!

[nathank (Nathan Kershaw)]

Realmente deveria aparecer na página de Categorias (ou outras páginas padrão), não deveria?

[rui5man]

Devido às restrições na China Continental, é difícil para a Stripe passar na revisão. Você poderia considerar integrar as interfaces do Alipay ou WeChat Pay?

[pfaffman (Jay Pfaffman)]

Perguntas semelhantes no passado tiveram uma resposta como “a coisa a fazer seria criar um plugin para Alipay ou WeChat Pay”. O discourse.org ganha dinheiro com aqueles que pagam pela hospedagem e não acho que eles tenham muitos clientes empresariais que queiram Alipay ou WeChat Pay, então você precisará perguntar em Marketplace ou desenvolvê-lo você mesmo. Talvez você possa interessar Alipay ou WeChat Pay em financiar o desenvolvimento.

[tknospdr (David Muszynski)]

@Discourse

Configuração

1. Instale e ative o plugin
2. Configure o Gateway de Pagamento (Stripe)
3. Configure Webhooks e Eventos no Stripe
4. Adicione suas chaves do Stripe (pública, secreta, secreta de webhook) em Admin > Plugins > Instalados > Assinaturas > Configurações /admin/site_settings/category/discourse_subscriptions?filter=plugin%3Adiscourse-subscriptions.
5. Crie um grupo para seus assinantes entrarem via compra
6. Crie um produto e plano em Admin > Plugins > Assinaturas
7. Lucro!

Consegui completar os itens de 1 a 5, mas acho que sou burro ou cego. Não consigo encontrar a interface para configurar produtos e planos no meu servidor.

Ugh, esquece… Encontrei. A última peça do quebra-cabeça é que não entendi isto:

• Para adicionar uma descrição ao seu produto, adicione um campo de metadados chamado “description” e use esse em vez disso. Você pode usar Markdown.

[tknospdr (David Muszynski)]

Acredito que configurei tudo corretamente. Se eu verificar a configuração para:\n~~O botão de assinatura mostrará a tabela de preços incorporada e o Stripe Checkout será usado.\nEntão as compras funcionam corretamente, no entanto, se eu desmarcar isso e usar a interface integrada, recebo caixas de erro como:\n\n\u003eEsperava-se um método de pagamento do tipo cartão, mas este PaymentIntent não tem um método de pagamento e nenhum foi fornecido. Tente novamente fornecendo os parâmetros payment_method ou payment_method_data.\n\nou~~\n\n\u003eEste cliente não tem uma fonte de pagamento anexada ou método de pagamento padrão. Considere adicionar um método de pagamento padrão. Para mais informações, visite https://stripe.com/docs/billing/subscriptions/payment-methods-setting#payment-method-priority.\n\nO erro principal é em um plano não recorrente, o inferior é um plano recorrente.\nAlguma dica de como consertar? Eu prefiro a interface integrada.\n\nEu resolvi isso, parece que enquanto eu mexia com usuários no ambiente de teste, o Stripe não gostou que eu usasse o mesmo usuário do Discourse com diferentes "usuários de assinatura".\n\nAlém disso, o OP deve esclarecer que \n\n\u003ePara adicionar uma descrição ao seu produto, adicione um campo de metadados chamado “description” e use esse em vez disso. Você pode usar Markdown.\n\nVá para o Painel do Stripe, clique em Catálogo de Produtos, clique em um Produto, depois clique em um Preço. É aqui que você encontrará os campos de metadados onde pode adicionar uma descrição.\n\nNo entanto, isso não pareceu funcionar para mim. Adicionei uma descrição de teste e nada mudou, nem usando a tabela do Stripe, nem o layout integrado.

[SubStrider]

Quando tento criar um produto, recebo um erro “500”. Estou configurando isso em um ambiente de teste. O que posso verificar para descobrir o motivo do erro do servidor?

Coisa semelhante em cupons

[Moin]

Existe uma entrada criada ao mesmo tempo em {YOURFORUM}/logs ?

[SubStrider]

Uau.. não sabia que essa página existia. Mostra chave de API inválida. Coloquei um lixo qualquer para a chave secreta para avançar e configurar os pacotes de assinatura por agora e voltar para as chaves mais tarde quando estiver pronto para testar.

[SubStrider]

Consegui configurar o plugin sem problemas, mas então percebi que este plugin só permite assinaturas recorrentes. Não assinaturas únicas que expiram após o período definido.

Como cobrar X valor por 30 dias. Após 30 dias, o usuário é removido do grupo premium. Eles podem comprá-lo novamente se quiserem. Normalmente, ofereço assinaturas de 1 mês, 3 meses e 12 meses.

O Stripe exige que eu me registre como uma empresa para poder oferecer suporte a pagamentos recorrentes. Estou recebendo pagamentos únicos no XenForo e o recurso nativo do XenForo lida com o vencimento da assinatura e a remoção da associação ao grupo.

Isso destrói completamente meu plano de migrar para o Discourse em um mês.

[pfaffman (Jay Pfaffman)]

Eu tenho uma solução. Posso ajudá-lo a criar uma ação do GitHub que extrairá dados do explorador de dados, incluindo o nome de usuário e o ID do grupo dos quais removê-los e, em seguida, alterará seu grupo de acordo.

Estou fazendo isso para um cliente que está migrando para o Discourse e tem um campo personalizado com datas. Portanto, precisamos mover os usuários para um grupo “expirando-em-breve” para dar-lhes um banner e, em seguida, para outro para removê-los do grupo pago quando o tempo acabar.

Se você tiver um orçamento, pode entrar em contato comigo ou perguntar em Marketplace. Estou planejando um post de blog sobre isso com um exemplo de propósito geral, se eu tiver um tempo livre.

[SubStrider]

Olá, as assinaturas funcionaram bem até o momento em que o retorno de chamada do Stripe chegou. Estou usando a Tabela de Preços do Stripe.

Posso ver que a assinatura foi registrada com sucesso na página admin/plugins/discourse-subscriptions/subscriptions.

No entanto, o usuário não foi movido para o grupo de usuários necessário.

Configurei o produto com o mesmo Nome do Produto do Stripe e também criei um plano de preços com o grupo selecionado. Mantive o preço como zero no plano de preços, pois presumo que seja irrelevante para a configuração da tabela de preços do Stripe.

O que estou perdendo?