# Stripe

The tap-stripe extractor pulls data from the Stripe API.

To learn more about tap-stripe, refer to the repository at https://gitlab.com/meltano/tap-stripe.

# 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

# Using the Command Line Interface

  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.

# Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
    
  2. Open the Extractors interface at http://localhost:5000/extractors.

  3. Click the "Add to project" button for "Stripe".

  4. Configure the settings below in the "Configuration" interface that opens automatically.

# 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

# Settings

tap-stripe requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents in the sidebar.

# Minimal configuration

A minimal configuration of tap-stripe in your meltano.yml project file will look like this:






 
 
 

plugins:
  extractors:
  - name: tap-stripe
    variant: meltano
    pip_url: git+https://gitlab.com/meltano/tap-stripe.git
    config:
      account_id: acct_1a2b3c4d5e
      start_date: '2020-10-01T00:00:00Z'

Sensitive values are most appropriately stored in the environment or your project's .env file:

export TAP_STRIPE_CLIENT_SECRET=sk_live_1a2b3c4d5e

# 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 UI, meltano config, or an environment variable:

meltano config tap-stripe set account_id <id>

export TAP_STRIPE_ACCOUNT_ID=<id>

# Client Secret

Secret API Key

# 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

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 UI, meltano config, or an environment variable:

meltano config tap-stripe set client_secret <secret>

export TAP_STRIPE_CLIENT_SECRET=<secret>

# Start Date

This property 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 UI, 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

# For example:
meltano config tap-stripe set start_date 2020-10-01T00:00:00Z

export TAP_STRIPE_START_DATE=2020-10-01T00:00:00Z