lgs / stripe-subscriptions

Dashboard module for adding Stripe subscriptions to web apps

Documentation for Stripe Connect

Index

• Introduction
• Module contents
• Import this module
• Setting up your Stripe credentials
• Configuring your products and plans
• Storage engine
• Access the API
• Github repository
• NPM package

Introduction

Dashboard bundles everything a web app needs, all the "boilerplate" like signing in and changing passwords, into a parallel server so you can write a much smaller web app.

The Stripe Subscriptions module adds a complete interface for creating and managing your Stripe products, plans, subscriptions etc and a complete interface for users to subscribe to plans. Users can self-cancel their subscriptions at any time and you can nominate a 0+ day period allowing users to refund themselves too. You can optionally require a subscription and/or no unpaid invoices from all users outside of the /account/ and /administrator/ content. The Stripe API documentation supplements this documentation.

Module contents

Dashboard modules can add pages and API routes. For more details check the sitemap.txt and api.txt or env.txt also contained in the online documentation.

Content type
Proxy scripts
Server scripts	Yes
Content scripts
User pages	Yes
User API routes	Yes
Administrator pages	Yes
Administrator API routes	Yes

Import this module

Install the module with NPM:

$ npm install @userdashboard/stripe-subscriptions

Edit your package.json to activate the module:

"dashboard": {
  "modules": [
    "@userdashboard/stripe-subscriptions"
  ]
}

Setting up your Stripe credentials

You will need to retrieve various keys from Stripe. During development your webhook will be created automatically, but in production with multiple dashboard server instances they share a configured webhook:

- create your Stripe account and find your API keys
- create a webhook for https://your_domain/webhooks/subscriptions/index-subscription-data 
- environment STRIPE_JS=3|2|false
- environment STRIPE_KEY=sk_test_xxxxxxx
- environment STRIPE_PUBLISHABLE_KEY=pk_test_xxxxxxx
- environment SUBSCRIPTION_WEBHOOK_ENDPOINT_SECRET=whsec_xxxxxxxx

Requiring subscriptions

Environment variables are documented in Dashboard and each module's /start-dev.sh.

You can require subscriptions and no overdue invoices through environment variables:

REQUIRE_SUBSCRIPTION=true
REQUIRE_PAYMENT=true

Configuring your products and plans

This module adds a complete interface for creating products and plans. Stripe's nomenclature and structure is used directly so for more information refer to the Stripe documentation and Stripe API documentation.

Users subscribe to plans and plans must be built from products. Additionally, this module imposes a 'publish' status on products and plans that controls access to them by users.

1. Administrator creates product
2. Administrator publishes product
3. Administrator creates plan
4. Administrator publishes plan
5. User selects plan from published plans
6. User creates subscription optionally with payment

You can use links for users to create a subscription to a specific plan:

/account/subscriptions/start-subscription?planid=X

Storage engine

By default this module will share whatever storage you use for Dashboard. You can specify an alternate storage module to use instead, or the same module with a separate database.

SUBSCRIPTIONS_STORAGE=@userdashboard/storage-postgresql
SUBSCRIPTIONS_DATABASE_URL=postgres://localhost:5432/subscriptions

Access the API

Dashboard and official modules are completely API-driven and you can access the same APIs on behalf of the user making requests. You perform GET, POST, PATCH, and DELETE HTTP requests against the API endpoints to fetch or modify data. This example fetches the user's subscriptions using NodeJS, you can do this with any language:

You can view API documentation within the NodeJS modules' api.txt files, or on the documentation site.

const subscriptions = await proxy(`/api/user/subscriptions/subscriptions?accountid=${accountid}&all=true`, accountid, sessionid)

const proxy = util.promisify((path, accountid, sessionid, callback) => {
    const requestOptions = {
        host: 'dashboard.example.com',
        path: path,
        port: '443',
        method: 'GET',
        headers: {
            'x-application-server': 'application.example.com',
            'x-application-server-token': process.env.APPLICATION_SERVER_TOKEN,
            'x-accountid': accountid,
            'x-sessionid': sessionid
        }
    }
    const proxyRequest = require('https').request(requestOptions, (proxyResponse) => {
        let body = ''
        proxyResponse.on('data', (chunk) => {
            body += chunk
        })
        return proxyResponse.on('end', () => {
            return callback(null, JSON.parse(body))
        })
    })
    proxyRequest.on('error', (error) => {
        return callback(error)
    })
    return proxyRequest.end()
  })
}