The tap-stripe Meltano extractor pulls data from Stripe that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-stripe are available. This document describes the default singer-io variant, which is recommended for new users.

Alternative variants are:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the tap-stripe extractor to your project using meltano add :

    meltano add extractor tap-stripe
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-stripe requires the configuration of the following settings:

The settings for extractor tap-stripe that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Account ID (account_id) #

How to get #

To get your account ID:

  1. Visit your profile: https://dashboard.stripe.com/settings/user
  • Or in the upper right, click on the avatar to access a dropdown, and click on Profile

Screenshot of what the avatar dropdown with Profile looks like

  1. Once the page loads, scroll to the bottom to find your account ID in the section labelled Accounts

Screenshot of account ID

  1. Copy and paste it somewhere you can refer later on when configuring the tap.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-stripe set account_id <account_id>

export TAP_STRIPE_ACCOUNT_ID=<account_id>

Secret API Key (client_secret) #

How to get #

To get your secret API key:

  1. Visit your Developer API Keys page: https://dashboard.stripe.com/apikeys
  • You can find this by clicking on the Developers link on the left navigation and clicking on API Keys

Screeenshot of where the Developers link is on the left side

  1. Under the Standard keys section, click on the button to Create secret key

:::tip No button?

If the “Create secret key” button is not available, a secret key may already have been generated before. In this case, use the “Reveal live key token” button under “Token” and to the right of “Secret key”. The token that appears is the secret key you can copy and paste into the data source configuration.

:::

Screenshot of where Create secret key button is

  1. To make things easy to track, assign the secret key a name of Meltano so you know why you created the key

Screenshot of naming secret key

  1. Once you click on Create, you should be greeted with you new API key which you’ll copy and paste into the data source configuration.

Screenshot of the new API key

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-stripe set client_secret <client_secret>

export TAP_STRIPE_CLIENT_SECRET=<client_secret>

Start Date (start_date) #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-stripe set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_STRIPE_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help? #

If you're having trouble getting the tap-stripe extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!