Payments with Stripe

ScaffoldHub uses Stripe to accept payments for the workspaces plans.

For this tutorial, we will use the Test Mode. You will need to repeat this process for Live Mode.

Before we continue, make sure you have a staging backend server deployed. Stripe needs a publicly accessible URL to be able to notify successful payments.

ScaffoldHub configuration files

Stripe must be configured on both frontend and backend files.

For the frontend:

  • frontend/src/config/staging.tsx (For React and Vue)

  • frontend/src/environments/environment.staging.ts (For Angular)

For the backend:

  • backend/.env

Create a Stripe account

Go to stripe.com and create a new account.

Save the API keys

  1. Go to the Get your test API keys tab.

  2. Copy the Publishable key to the frontend config file.

  3. Save it on stripePublishableKey.

  4. Copy the Secret key to the backend config file.

  5. Save it on PLAN_STRIPE_SECRET_KEY.

Create the plans

By default, ScaffoldHub uses Growth and Enterprise as the plan names. Feel free to change those names, add or remove a plan. This will require changing the code. See Architecture > Payments for more details.

Go to Products > Add Product.

Fill the Product's information.

  • Name

  • Price

  • Recurring

  • Billing Period

Copy the Price Codes and save on the backend environment variables.

PLAN_STRIPE_PRICES_GROWTH = "price_..."
PLAN_STRIPE_PRICES_ENTERPRISE = "price_..."

Enable the Customer Portal

Go to Settings > Billing > Customer Portal.

Enable the functionalities you want on the customer portal.

Read more about the customer portal here: https://stripe.com/docs/billing/subscriptions/customer-portal‚Äč

Create a Webhook

The webhook is responsible for notifying the application when the plans' subscriptions have changed.

Go to Developers > Webhooks > Add Endpoint.

The backend URL must have this format: https://your_backend_url/api/plan/stripe/webhook

Events you need to capture are:

  • checkout.session.complete

  • customer.subscription.updated

  • customer.subscription.deleted

Done! You can now use payments on your application.