Stripe + Steampipe

Stripe provides payment processing software and application programming interfaces (APIs) for e-commerce websites and mobile applications.

Steampipe is an open-source zero-ETL engine to instantly query cloud APIs using SQL.

For example:

select
  id,
  name,
  description
from
  stripe_product

+---------------------+-----------------------+------------------------+
| id                  | name                  | description            |
+---------------------+-----------------------+------------------------+
| prod_Gm5Ugng0ZhPIxt | Airstream Deluxe A4   | The Cadillac of Paper. |
| prod_Hx0RdoxVyNJ3aC | 40 pound Letter Stock | <null>                 |
| prod_GnCKT8Km8WsOwK | Premium Copy Paper    | <null>                 |
+---------------------+-----------------------+------------------------+

Documentation

Table definitions & examples →

Get started

Install

Download and install the latest Stripe plugin:

steampipe plugin install stripe

Credentials

Item	Description
Credentials	Stripe requires an API key for all requests.
Radius	Each connection represents a single Stripe account.

Configuration

Installing the latest stripe plugin will create a config file (~/.steampipe/config/stripe.spc) with a single connection named stripe:

connection "stripe" {
  plugin   = "stripe"
  api_key = "sk_test_giG4MlyrcybGi1YFDEXAMPLE"
}

api_key - Your Stripe API key for test or live data.

Postgres FDW

This plugin is available as a native Postgres FDW. Unlike Steampipe CLI, which ships with an embedded Postgres server instance, the Postgres FDW can be installed in any supported Postgres database version.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_postgres_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/postgres.sh)" -- stripe

The installer will prompt you for the plugin name and version, download and install the appropriate files for your OS, system architecture, and Postgres version.

To configure the Postgres FDW, you will create an extension, foreign server, and schema and import the foreign schema.

CREATE EXTENSION IF NOT EXISTS steampipe_postgres_stripe;
CREATE SERVER steampipe_stripe FOREIGN DATA WRAPPER steampipe_postgres_stripe OPTIONS (config '<your_config>');
CREATE SCHEMA stripe;
IMPORT FOREIGN SCHEMA stripe FROM SERVER steampipe_stripe INTO stripe;

SQLite Extension

This plugin is available as a SQLite Extension, making the tables available as SQLite virtual tables.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_sqlite_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/sqlite.sh)" -- stripe

The installer will prompt you for the plugin name, version, and destination directory. It will then determine the OS and system architecture, and it will download and install the appropriate package.

To configure the SQLite extension, load the extension module and then run the steampipe_configure_stripe function to configure it with plugin-specific options.

$ sqlite3
sqlite> .load ./steampipe_sqlite_extension_stripe.so
sqlite> select steampipe_configure_stripe('<your_config>');

Export

This plugin is available as a standalone Export CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- stripe

You can pass the configuration to the command with the --config argument:

steampipe_export_stripe --config '<your_config>' <table_name>