Stripe

tap-stripe (singer-io variant)🥈

Online payment processing for internet businesses

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

Alternate Implementations

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
    :
  2. meltano add extractor tap-stripe
  3. Configure the tap-stripe settings using
    meltano config
    :
  4. meltano config tap-stripe set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-stripe test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-stripe may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-stripe settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-stripe list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Account ID (account_id)

  • Environment variable: TAP_STRIPE_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.

Configure this setting directly using the following Meltano command:

meltano config tap-stripe set account_id [value]

Secret API Key (client_secret)

  • Environment variable: TAP_STRIPE_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


Configure this setting directly using the following Meltano command:

meltano config tap-stripe set client_secret [value]

Start Date (start_date)

  • Environment variable: TAP_STRIPE_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.


Configure this setting directly using the following Meltano command:

meltano config tap-stripe set start_date [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

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.

Install

meltano add extractor tap-stripe

Maintenance Status

  • Maintenance Status

Repo

https://github.com/singer-io/tap-stripe
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api