Stripe Connector

Overview

Stripe is a technology company allowing businesses to accept payments over the Internet.

The Datacoral Stripe connector collects data from an Stripe account and enables data flow from an Stripe account into a data warehouse, such as Redshift.

Steps to add this connector to your installation

The steps to launch your connector are:

  1. Generate Stripe API keys
  2. Specify the connector configuration
  3. Add the Stripe connector

1. Generate Stripe API keys

Please make sure to have the access to an active Stripe account before the setup.

Setup instructions

The Stripe connector requires an API key to collect data. An API key can be obtained from Stripe through the following steps:

  1. Log in your Stripe account and go to API keys dashboard
  2. Make sure that you are viewing live API keys. If not, toggle the "View test data" option off.
  3. Under the "Standard keys" section, click on "Create secret key" and give it a name, say Datacoral Key.
  4. Copy the API key that was just created. It should look like: sk_live_xxxxxxxxxxxxxxx.

Notes:

  • For older Stripe keys, you can retrieve the API key later (by clicking on "Reveal live key"), but for newer keys, that is no longer an option.
  • Stripe offers two kinds of API keys: Standard keys and Restricted Keys. We recommend using a Standard key for the Datacoral connector since it provides access to all Stripe objects, whereas Restricted Keys don't allow fetching certain objects (such as Account). However, Restricted Keys allow granular access to objects. If you pick a restricted key, please provide Read access to all the resources you would like Datacoral to replicate.

2. Specify the connector configuration

To get a starting template for the Stripe connector configuration, save the output of the describe --input-parameters command as follows:

datacoral collect describe --slice-type stripe \
--input-parameters > stripe_parameters_file.json

Necessary input parameters:

  • api_key- your Stripe API key

Example template:

{
"api_key": "test"
}

Modify the stripe_parameters_file file to add the api_key generated from Stripe

3. Add the connector

datacoral collect add --slice-type stripe --slice-name <slice-name> --parameters-file <params-file>
  • slice-name Name of your connector. A schema with your slice-name is automatically created in your warehouse
  • params-file File path to your input parameters file. Ex. stripe_parameters_file.json

Supported load units

The Stripe connector automatically collects the following loadunits from the Stripe API and makes them available in your warehouse for analysis.

  • accounts: captures all Stripe accounts accessible by your API key
  • balance_transaction_fee_details: captures fee details for all balance transactions (child of balance_transactions)
  • balance_transactions: captures all balance transactions
  • balances: captures your current Stripe balance
  • capabilities: captures all capabilities for all Stripe accounts
  • cards: captures all customer cards
  • charges: captures all charges that are applied or to be applied to a card
  • coupons: captures all coupons containing a discount to be applied for a customer
  • credit_notes: captures all credit notes in your Stripe accounts
  • customers: captures all your customers
  • discounts: captures all discounts in your accounts
  • disputes: captures all disputes from your customers
  • early_fraud_warnings: captures all early fraud warnings from card issuers
  • events_all: captures all the attributes for all events created withing your Stripe account
  • invoice_items: captures all additonal invoice items for your customers
  • invoice_lines: captures individual line items for all invoices (child of invoices)
  • invoices: captures all invoices owed by your customers
  • payment_intents: captures all payment intents for your customers
  • payment_methods: captures all payment methods which are instruments that your customers use to pay you
  • plans: captures all subscriptions plans for your products
  • products: captures all the products and services you offer
  • refunds: captures all refunds for your customers
  • setup_intents: captures all setup intents for customer payment credentials
  • subscription_events: captures all the attributes for subscription events created withing stripe account
  • subscription_items: captures all subscription items
  • subscriptions: captures all subscriptions across your customers
  • tax_ids: captures all tax IDs associated with a customer
  • transactions: captures all transactions in your Stripe account
  • transfers: captures all transfers between Stripe accounts

Connector output

Output of this connector is stored in S3 and your data warehouse.

AWS S3 Data stored in AWS S3 is partitioned by date and time s3://customer_installation.datacoral/<slice-name>

Data Warehouse: Schema - schema name will be same as slice-name Tables produced by the connector look like slice-name.<load unit name> where the list of load units is specified in the previous section.

Questions? Interested?

If you have questions or feedback, feel free to reach out at hello@datacoral.co or Request a demo