Stripe

Developer guide
Live Demo Github Community User Guide
Search…
v8 (v7 Rails v1 Django)
Getting Started
Extra help
Stripe
Configuring the Stripe integration for Forest allows you to have your customer’s payments, invoices, cards and subscriptions (1) alongside the corresponding customer from your application. A Refund Smart Action (2,3) is also implemented out-of-the-box.
SQL
Mongodb
Rails
On our Live Demo, we’ve configured the Stripe integration on the customers collection. The Stripe Customer ID is already stored on the database under the field stripe_id.
middlewares/forestadmin.js
1
...
2
const { objectMapping, connections } = require('../models');
3
​
4
module.exports = function (app) {
5
  app.use(Liana.init({
6
    configDir: path.join(__dirname, '../forest'),
7
    envSecret: process.env.FOREST_ENV_SECRET,
8
    authSecret: process.env.FOREST_AUTH_SECRET,
9
    objectMapping,
10
    connections,
11
    integrations: {
12
      stripe: {
13
        apiKey: process.env.STRIPE_SECRET_KEY,
14
        mapping: 'customers.stripe_id',
15
        stripe: require('stripe')
16
      }
17
    }
18
  }));
19
​
20
  console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
21
};
Copied!
On our Live Demo, we’ve configured the Stripe integration on the customers collection. The Stripe Customer ID is already stored on the database under the field stripe_id.
middlewares/forestadmin.js
1
...
2
const { objectMapping, connections } = require('../models');​
3
​
4
module.exports = function (app) {
5
  app.use(Liana.init({
6
    configDir: path.join(__dirname, '../forest'),
7
    envSecret: process.env.FOREST_ENV_SECRET,
8
    authSecret: process.env.FOREST_AUTH_SECRET,
9
    objectMapping,
10
    connections,
11
    integrations: {
12
      stripe: {
13
        apiKey: process.env.STRIPE_SECRET_KEY,
14
        mapping: 'customers.stripe_id',
15
        stripe: require('stripe')
16
      }
17
    }
18
  }));
19
​
20
  console.log(chalk.cyan('Your admin panel is available here: https://app.forestadmin.com/projects'));
21
};
Copied!
On our Live Demo, we’ve configured the Stripe integration on the Customer collection. The Stripe Customer ID is already stored on the database under the field stripe_id.
/config/initializers/forest_liana.rb
1
ForestLiana.env_secret = Rails.application.secrets.forest_env_secret
2
ForestLiana.auth_secret = Rails.application.secrets.forest_auth_secret
3
​
4
ForestLiana.integrations = {
5
  stripe: {
6
    api_key: ENV['STRIPE_SECRET_KEY'],
7
    mapping: 'Customer.stripe_id'
8
  }
9
}
Copied!
Available options
Here are the complete list of available options to customize your Stripe integration.
Name
Type
Description
api_key
string
The API Secret key of your Stripe account. Should normally starts with sk_.
mapping
string
Indicates how to reconcile your Customer data from your Stripe account and your collection/field from your database. Format must be model_name.stripe_customer_id_field
A stripe option is also available to use the official Node.js Stripe library NPM package.
Reference Guide - Previous
Integrations
Mixpanel
Last modified 3mo ago
Copy link
Contents