Official

Premium

Stripe

The CloudQuery Stripe plugin pulls data from Stripe and loads it into any supported CloudQuery destination

Publisher

cloudquery

Latest version

v4.0.0

Type

Source

Platforms

Date Published

October 22, 2024

Price per 1M rows

Starting from $15

monthly free quota

1M rows

Documentation Tables Changelog Destinations

Overview

Set up process #

brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync stripe.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview #

The CloudQuery Stripe plugin pulls data from Stripe and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

Authentication #

In order to fetch information from Stripe, cloudquery needs to be authenticated using a secret API key from your Stripe account. You can view and manage your API keys in the Stripe Dashboard.

Example Configuration #

This example syncs from Stripe to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference. Incremental syncing is enabled and will be saved to the cq_state_stripe table.

kind: source
# Common source-plugin configuration
spec:
  name: stripe
  path: cloudquery/stripe
  registry: cloudquery
  version: "v4.0.0"
  tables: ["*"]
  destinations: ["postgresql"]
  skip_tables:
    - stripe_issuing*  # Needs sign-up at https://stripe.com/issuing
    - stripe_treasury* # Needs sign-up at https://stripe.com/treasury
    - stripe_sigma_scheduled_query_runs # Live keys only
  backend_options:
    table_name: "cq_state_stripe"
    connection: "@@plugins.postgresql.connection"
  # Stripe specific configuration
  # Learn more about the configuration options at https://cql.ink/stripe_source
  spec:
    # required
    api_key: "${STRIPE_API_KEY}"

Note that if backend_options is omitted, by default no backend will be used. This will result in all items being fetched on every sync.

For more information about managing state for incremental tables, see Managing Incremental Tables.

Configuration Reference #

This is the (nested) spec used by the Stripe source plugin:

api_key (string) (required)
Your secret API key from the Stripe Dashboard.
rate_limit (integer) (optional) (default: varies)
Used to override number of requests allowed per second. Defaults to 90 req/sec for production environment keys, otherwise 20 req/sec.
max_retries (integer) (optional) (default: 2)
Number of retries if a request was rate limited at the API endpoint.
concurrency (integer) (optional) (default: 1000)
A best effort maximum number of Go routines to use. Lower this number to reduce memory usage.
scheduler (string) (optional) (default: dfs)
The scheduler to use when determining the priority of resources to sync. Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.
For more information about this, see performance tuning.
stripe_debug (boolean) (optional) (default: false)
Enables verbose logging on the Stripe client.