Stripe Source Plugin

Latest: v2.1.11

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 (opens in a new tab) from your Stripe account. You can view and manage your API keys in the Stripe Dashboard (opens in a new tab).

Example

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 a .cq/state/ directory by default.

kind: source
# Common source-plugin configuration
spec:
  name: stripe
  path: cloudquery/stripe
  version: "v2.1.11"
  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
  spec:
    api_key: "<YOUR_SECRET_API_KEY_HERE>"

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: 10000):

Number of concurrent requests to Stripe API.
stripe_debug (boolean) (optional) (default: false):

Enables verbose logging on the Stripe client.

Tables Tables