Search results
Suggest a FeaturePDF

Stripe

Stripe is an online payment platform that enables businesses to securely process and manage customer transactions over the Internet.

Grab Credentials

  1. Log in to your Stripe account.
  2. Click on Settings in the top right corner.
  3. Navigate to Developers in the top menu.
  4. Choose “API Keys”.
  5. Under “Standard Keys”, click on “Reveal test key” next to the Secret Key.
  6. Make a note of the API_secret_key for configuring secrets.toml.

Connection Properties

The configuration section in the YAML file includes the following properties:

Connectorname: Stripe
Stripe_secret_key: Stripe secret key

Metadata Properties

In this section, define the mode of data refresh. There are two modes: INCREMENTAL and FULL_TABLE.

INCREMENTAL
metadata:
    TableName:
        replication_method: INCREMENTAL
        replication_key: Column name
        replication_value: column value that data starts from
This mode will retrieve data from the date column specified in the replication key starting from the date indicated in the replication value. Once it is scheduled, the replication value will be automatically updated based on the imported data.
FULL_TABLE
      metadata:
    TableName:
        replication_method: FULL_TABLE
        replication_key: Column name
        replication_value: column value that data starts from
        interval_type: days/hours/minutes/year/month
        interval_value: integer value to add in interval type
This mode will fetch data from the date column mentioned in the replication key starting from the date specified in the replication value. Once scheduled, the replication value is automatically updated from the imported data.

Example

FULL_TABLE

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: stripe_data
      connectorname: stripe
      config:
        stripe_secret_key: <SECRET KEY>
      select:
         - TABLE1
         - TABLE2
      metadata:
        TABLE1:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00
          interval_type: days
          interval_value: 6
        TABLE2:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00
          interval_type: days
          interval_value: 6

INCREMENTAL

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: stripe_data
      connectorname: stripe
      config:
        stripe_secret_key: <SECRET KEY>
      select:
         - TABLE1
         - TABLE2
      metadata:
        TABLE1:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00
        TABLE2:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: 2023-07-19 00:00:00

Configure the Data Hub to connect Stripe

  1. To start, Click the Bold Data Hub icon on the Navigation Pane.

Stripe Data Hub - Reports

  1. Click Add Project and provide the name for the new project.

Stripe Data Hub - Reports

  1. Select the newly created project and add the Stripe template.

Stripe Data Hub - Reports

  1. Update the stripe secret key in the template. Also, Update the resources on the select property and Click Save, choose the desired destination to save the pipeline.

Stripe Data Hub - Reports

  1. Creating a Pipeline in Bold Data Hub automatically creates a Data Source in Bold Reports®. The Bold Reports® Data Source is a live data source to the destination database used in Bold Data Hub.
The available resources are supported in Stripe
- Subscription
- Account
- Coupon
- Customer
- Product
- Price
- Event
- Invoice
- BalanceTransaction

Warning:

1. The `Encrypt_Credentials` property should be set to false when updating the new access token on the template. If you have modified other properties, such as 'select' or 'account id', the `Encrypt_Credentials` property must be set to true.  
2. The default lifetime of the access token is 1 hour. Therefore, you need to convert it to a long-lived access token in order to use the same token for 60 days. Existing tables should be maintained even if the token has expired or is being used as an invalid token.

Schedule Data Hub Job

  1. To configure interval-based scheduling, click on the schedules tab and select the created pipeline and click on the schedule icon and configure it.

Stripe - Reports

Stripe - Reports

  1. For on-demand refresh, click Run Now button.

Stripe - Reports.

  1. The Schedule history can be checked using the history option as well as logs.

Stripe - Reports

  1. Click on Logs to see if the run is completed and data source is created in Bold Reports®.

Stripe - Reports

  1. Click Edit DataSource Option to view the created tables.