Authentication #

Example Configuration #

kind: source
# Common source-plugin configuration
spec:
  name: stripe
  path: cloudquery/stripe
  registry: cloudquery
  version: "v4.1.4"
  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}"

Configuration Reference #

• 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.