 |
Summary | Discourse Subscriptions allows site owners to sell recurring and one-time purchase subscriptions that grant access to a group on a Discourse instance. |
 |
Repository Link | https://github.com/discourse/discourse-subscriptions |
 |
Install Guide | How to install plugins in Discourse |
The Subscription Plugin allows you to create one-time as well as recurring subscriptions that users can pay for in order to access gated content. This can be a great way to fund the hosting cost of your community.
Features
Discourse Subscriptions supports the following features:
- Create new products and plans from the admin panel
- Cancel and refund subscriptions from the admin panel
- Create one time purchase or recurring subscription plans
- Add free trials on recurring subscriptions
- SCA/3D Secure support
- Add/remove users from plan groups as they subscribe/cancel
- Cancel subscription from user profile
- Cancellation of subscription at end of subscription period
- Optional Support for Stripe Checkout
- Automatic sales tax calculation and collection
- Users can update their card for individual subscriptions
The “Subscribe” button located in the top nav will take you to the Subscribe page /s where it lists the subscriptions you have configured for your site:
Once a user clicks on one of the “Subscribe” button for a specific plan it will open up the payment page for that plan:
After a user fills out their payment details and their address and click “Subscribe”, they are shown a “Thank you!” message and taken to their billing page:
The user is also automatically added to a group of your choosing so that you can easily see which users have subscribed as well as provide gated content in categories only that group can see.
Terms
- Subscription - Subscriptions are a recurring payment plan which allow you to control access to content on your community. When a subscription is created or deleted, a user is added or removed from the user group you associate with your subscription plan. A subscription is made up of a product and plans.
-
Product - A product in Stripe’s terms is what you’re selling. A product can contain one or more plans.
- To add a description to your product, add a metadata field named “description” and use that one instead. You can use Markdown.
- Plan - A plan contains a price, recurring cycle, and associates with a group to which your subscribers gain access.
Be very careful to keep your Stripe private keys safe and secure at all times.
If you were to shut down your instance of Discourse, uninstall this plugin or your site were to go offline, Stripe will continue to bill your customers for your service until the subscription is cancelled.
Configuration
- Install & enable the plugin
- Configure Payment Gateway (Stripe)
- Configure Webhooks & Events in Stripe
- Add your Stripe keys (public, secret, webhook secret) under Admin > Plugins > Installed > Subscriptions > Settings
/admin/site_settings/category/discourse_subscriptions?filter=plugin%3Adiscourse-subscriptions. - Create a group for your subscribers to join via purchase
- Create a product and plan under Admin > Plugins > Subscriptions
- Profit!
Set up your Payment Gateway.
Firstly, you’ll need an account with the Stripe payment gateway. To get started, you can set up an account in test mode and see how it all works without making any real transactions or having to set up a bank account. There is no test mode toggle in the plugin; instead, be sure to use your developer keys (they begin with pk_test, sk_test)
Set up Webhooks and Events in your Stripe account
Webhooks are required to make subscription cancellations work fully. Be sure you have them configured correctly.
Once you have an account on Stripe, you’ll need to tell Stripe your website’s address so it can notify you about certain transactions. You can enter this in your Stripe dashboard under Endpoints > URL.
Webhooks address: [your server address]/s/hooks – where [your server address] is the URL of your Discourse install.
You’ll also need to tell Stripe which events it should notify you about via the webhook URL.
Currently, Discourse Subscriptions responds to the following events:
customer.subscription.deletedcustomer.subscription.updatedcheckout.session.completed
Add the Stripe API and Webhook keys to your plugin settings
Stripe needs to be authorized to communicate with your website. To do this, it publishes a pair of private and public API keys and a signing secret for your web hooks.
To authorize webhooks, add the API keys and webhook secret from Stripe to your settings page (under Developers).
View test datamode and getpk_testandsk_testkeys under Developers.
In your Stripe account settings, see:
Add these keys under the appropriate settings in Admin > Plugins > Installed > Subscriptions > Settings /admin/site_settings/category/discourse_subscriptions?filter=plugin%3Adiscourse-subscriptions.
Set up your User Groups in Discourse
When a user successfully subscribes to your Discourse application, after their credit card transaction has been processed, they are added to a User Group. By assigning users to a User Group, you can manage what your users have access to on your website. User groups are a core functionality of Discourse and this plugin does nothing with them except add and remove users from the group you associated with your Plan.
Create one or more products with plans.
Under Admin > Plugins > Subscriptions, click add a new Product. Once you have a product saved, you can add plans to it. Keep in mind that the pricing and billing intervals of plans cannot be changed once you create them. This is to avoid confusion around subscription management.
If you take a look at your Stripe Dashboard, you’ll see all those products and plans are listed. Discourse Subscriptions does not create them locally. They are created in Stripe.
Testing
Test with these credit card numbers:
- 4242 4242 4242 4242
- 4111 1111 1111 1111 (no authentication required)
- 4000 0027 6000 3184 (authentication required)
For more test card numbers: Test card numbers | Stripe Documentation
Visit /s and enter a few test transactions.
Going Live
Once you’re ready to go live, change your API and webhook secret keys to production keys. You will need to create new products and plans in live mode.
Do be aware that if if you don’t properly configure Stripe webhooks, and recurring payments fail to process for any reason (expired credit card, etc.), users will still have access to the group . To have Stripe automatically cancel subscriptions, be sure to set your Manage failed payments settings similar to the below image and configure webhooks as described above.
Update Payment Info
Users can update their card used for individual subscriptions by visiting the billing page and clicking the edit button next to the subscription which will open up this screen:
Stripe Checkout with Stripe Pricing Tables
You can also opt to replace the Subscription Plugin product and checkout pages and instead use Stripe Checkout with Stripe Pricing Tables.
To use Stripe Checkout with the Subscription plugin setup a Pricing Table inside of Stripe and add the pricing-table-id from the Pricing Table embed code to the discourse_subscriptions_pricing_table_id site setting as well as enabling the feature.
Automatic Tax Collecting
To enable Automatic Tax Collecting check the Site Setting box for discourse_subscriptions_enable_automatic_tax.
If you enable it, but you have not configured your Stripe instance properly to collect tax users may see this popup after completing the checkout process:
There is this guide for more info, but there shouldn’t be much to do since the plugin is now passing in the appropriate automatic_tax[enabled]=true parameter (step 5).
Be sure you configure your registrations (step 4) as well:
Here is an example Discourse Subscription Plugin transaction in Stripe showing that tax was automatically collected:
Settings
| Name | Description |
|---|---|
| discourse subscriptions enabled | Enable the Discourse Subscriptions plugin. |
| discourse subscriptions extra nav subscribe | Show the subscribe button in the primary navigation |
| discourse subscriptions public key | Stripe Publishable Key |
| discourse subscriptions secret key | Stripe Secret Key |
| discourse subscriptions webhook secret | Stripe Webhook Secret |
| discourse subscriptions currency | Default Currency Code. This can be overridden when creating a subscription plan. |
| discourse subscriptions campaign enabled | Enables a campaign banner to promote supporting this community financially. |
| discourse subscriptions campaign goal | The numerical goal for your support campaign (subscribers or amount raised). |
| discourse subscriptions campaign type | Selects the type of campaign to run (subscribers or monthly amount raised). |
| discourse subscriptions campaign banner location | Selects the location of the campaign banner (top or sidebar). |
| discourse subscriptions campaign banner bg image | Upload a custom image to use as the background on the campaign banner. |
| discourse subscriptions campaign banner shadow color | Selects the color of the campaign banner drop shadow. |
| discourse subscriptions campaign show contributors | Show avatars of the most recent purchases of subscription products. |
| discourse subscriptions campaign product | The Stripe product id to send supporters when they click the button on the campaign. If this setting is blank, supporters will be directed to the main products page. |
| discourse subscriptions campaign grant | Grants the user a free month of subscriptions |
| discourse subscriptions pricing table id | The Stripe pricing table id from the embed code |
| discourse subscriptions pricing table enabled | Enables using the Stripe pricing table and replaces the existing subscribe page |
| discourse_subscriptions_enable_automatic_tax | Toggles if sales tax is going to be collected. Requires some setup in Stripe. |
Last edited by @nathank 2024-08-29T20:05:05Z
Last checked by @MarkDoerr 2024-07-11T20:25:35Z
Check document
Perform check on document: