Prepare for the PgBouncer and IPv4 deprecations on 26th January 2024

Learn more
Back
Stripe Wrapper

Stripe Wrapper

Overview

supabase/wrappers is a PostgreSQL extension that provides integrations with external sources so you can interact with third-party data using SQL.

For example, the Stripe wrapper connects to Stripe's API and exposes each endpoint as a SQL table.


_10
select
_10
customer_id
_10
currency
_10
from
_10
stripe.customers;
_10
_10
customer_id | currency
_10
--------------------+-----------
_10
cus_MJiBtCqOF1Bb3F | usd
_10
(1 row)

Usage

Preparation

Before you get started, make sure the wrappers extension is installed on your database:


_10
create extension if not exists wrappers with schema extensions;

and then create the foreign data wrapper:


_10
create foreign data wrapper stripe_wrapper
_10
handler stripe_fdw_handler
_10
validator stripe_fdw_validator;

Secure your credentials (optional)

By default, Postgres stores FDW credentials inide pg_catalog.pg_foreign_server in plain text. Anyone with access to this table will be able to view these credentials. Wrappers is designed to work with Vault, which provides an additional level of security for storing credentials. We recommend using Vault to store your credentials.


_10
-- Save your Stripe API key in Vault and retrieve the `key_id`
_10
insert into vault.secrets (name, secret)
_10
values (
_10
'stripe',
_10
'YOUR_SECRET'
_10
)
_10
returning key_id;

Connecting to Stripe

We need to provide Postgres with the credentials to connect to Stripe, and any additional options. We can do this using the create server command:

With Vault:


_10
create server stripe_server
_10
foreign data wrapper stripe_wrapper
_10
options (
_10
api_key_id '<key_ID>' -- The Key ID from above.
_10
);

Without Vault:


_10
create server stripe_server
_10
foreign data wrapper stripe_wrapper
_10
options (
_10
api_key '<Stripe API Key>' -- Stripe API key, required
_10
);

Learn more on our docs page.

Resources

Details

DeveloperSupabase
DocumentationLearn