Setting up credentials for Stripe in Soapbox

In order to use the Stripe payment processor, you will need to input your Stripe API credentials into Soapbox Engage account.  You can find your Stripe API credentials by logging into your Stripe account and going to Developers > API Keys, and noting your Publishable Key and Secret Key.  Alternatively, you can follow the instructions for finding your API Keys directly from Stripe's support article.

If you wish to accept recurring payments through Soapbox Donations, you will need to create a Product and Price with Stripe and enter this Price ID in your Payment Processor Settings as the Default Plan.

How you enter these credentials in Soapbox is determined by the version of the Soapbox administrator your site has: Soapbox Lightning, Soapbox Engage Classic, or Soapbox CMS Classic.

For Soapbox sites using the Soapbox Lightning administrator:

1. Login to your Soapbox Engage administrator
2. In the right column, click Payment Processor Settings
3. For Payment Gateway, select Stripe
4. For Publishable Key, enter the information from your Stripe account
5. For Secret Key, enter the information from your Stripe account
6. For Test Mode, select No, if you are using a Stripe production account, or Yes, if you are using a Stripe sandbox account for testing purposes
7. Click Save Payment Processor Settings

IMPORTANT: If you wish to accept recurring payments through the Donations app, you will need to  create a Product and Price with Stripe and enter this Price ID in your Payment Processor Settings as the Default Price.

For Soapbox sites using the Soapbox Engage Classic administrator:

1. Login to your Soapbox Engage administrator
2. In the right column, click Payment Processor Settings
3. For Payment Gateway, select Stripe
4. For Publishable Key, enter the information from your Stripe account
5. For Secret Key, enter the information from your Stripe account
6. For Test Mode, select No, if you are using a Stripe production account, or Yes, if you are using a Stripe sandbox account for testing purposes
7. Click Save Payment Processor Settings

IMPORTANT: If you wish to accept recurring payments through the Donations app, you will need to  create a Product and Price with Stripe and enter this Price ID in your Payment Processor Settings as the Default Price.

For Soapbox sites using the Soapbox CMS Classic administrator:

1. Login to your Soapbox Engage administrator
2. In the main menu, go to Extensions > Plugin Manager
3. In the Plugin Manager, in the upper right for the drop down that says "- Select Type -", choose "payment-gateway"
4. In the filtered list of plugins, disable any except Payment Gateway - Stripe by clicking the icon in the Enabled column
5. Enable Payment Gateway - Stripe by clicking the icon in the Enabled column
6. Click Payment Gateway - Stripe
7. For Publishable Key, enter the information from your Stripe account
8. For Secret Key, enter the information from your Stripe account
9. For Test Mode, select No, if you are using a Stripe production account, or Yes, if you are using a Stripe sandbox account for testing purposes
10. Click Save

IMPORTANT: If you wish to accept recurring payments through Soapbox Donations, you will need to  create a Product and Price with Stripe and enter this Price ID in your Payment Processor Settings as the Default Plan.

Experimental - Using Stripe Restricted Keys

Stripe provides the ability to create additional API keys that can be limited to only approved actions. The following is experimental, and should not be used in production environments without first thorough testing by your team.

These are the actions you should ensure the Stripe restricted keys provide to Soapbox Engage.

• Charges (Write)
• Customer (Write)
• Events (Read)
• PaymentIntent (Write)
• PaymentMethods (Write)
• Products (Read)
• SetupIntents (Write)
• Tokens (Write)
• Sources (Write)
• Plans (Read)
• Subscriptions (Write)
• Transaction (Write)