Stripe

This package models Stripe data from Fivetran's connector. It uses data in the format described by this ERD.

This package enables you to better understand your Stripe transactions. Its main focus is to enhance the balance transaction entries with useful fields from related tables. Additionally, the metrics tables allow you to better understand your account activity over time or at a customer level. These time-based metrics are available on a daily, weekly, monthly, and quarterly level.

Models

This package contains transformation models, designed to work simultaneously with our Stripe source package. A dependency on the source package is declared in this package's packages.yml file, so it will automatically download when you run dbt deps. The primary outputs of this package are described below. Intermediate models are used to create these output models.

model	description
stripe__balance_transactions	Each record represents a change to your account balance, enriched with data about the transaction.
stripe__invoice_line_items	Each record represents an invoice line item, enriched with details about the associated charge, customer, subscription, and plan.
stripe__subscription_details	Each record represents a subscription, enriched with customer details and payment aggregations.
stripe__subscription_line_items	Each record represents a subscription invoice line item, enriched with details about the associated charge, customer, subscription, and plan. Use this table as the starting point for your company-specific churn and MRR calculations.
stripe__customer_overview	Each record represents a customer, enriched with metrics about their associated transactions. Transactions with no associated customer will have a customer description of "No associated customer".
stripe__daily_overview	Each record represents a single day, enriched with metrics about balances, payments, refunds, payouts, and other transactions.
stripe__weekly_overview	Each record represents a single week, enriched with metrics about balances, payments, refunds, payouts, and other transactions.
stripe__monthly_overview	Each record represents a single month, enriched with metrics about balances, payments, refunds, payouts, and other transactions.
stripe__quarterly_overview	Each record represents a single quarter, enriched with metrics about balances, payments, refunds, payouts, and other transactions.

Installation Instructions

Check dbt Hub for the latest installation instructions, or read the dbt docs for more information on installing packages.

Include in your packages.yml

packages:
  - package: fivetran/stripe
    version: [">=0.7.0", "<0.8.0"]

Configuration

By default, this package will look for your Stripe data in the stripe schema of your target database. If this is not where your Stripe data is, please add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
config-version: 2

vars:
  stripe_source:
    stripe_database: your_database_name
    stripe_schema: your_schema_name

For additional configurations for the source models, please visit the Stripe source package.

Disabling Models

This package takes into consideration that not every Stripe account utilizes the invoice, invoice_line_item, payment_method, payment_method_card, plan, or subscription features, and allows you to disable the corresponding functionality. By default, all variables' values are assumed to be true. Add variables for only the tables you want to disable:

# dbt_project.yml

...
vars:
    using_invoices:        False  #Disable if you are not using the invoice and invoice_line_item tables
    using_payment_method:  False  #Disable if you are not using the payment_method and payment_method_card tables
    using_subscriptions:   False  #Disable if you are not using the subscription and plan tables.

Leveraging Subscription Vs Subscription History Sources

For Stripe connectors set up after February 09, 2022 the subscription table has been replaced with the new subscription_history table. By default this package will look for your subscription data within the subscription source table. However, if you have a newer connector then you must leverage the stripe__subscription_history to have the package use the subscription_history source rather than the subscription table.

Please note that if you have stripe__subscription_history enabled then the package will filter for only active records.

# dbt_project.yml

...
vars:
    stripe__subscription_history: True  # False by default. Set to True if your connector syncs the `subscription_history` table.

Changing the Build Schema

By default this package will build the Stripe staging models within a schema titled (<target_schema> + _stg_stripe) and the Stripe final models within a schema titled (<target_schema> + _stripe) in your target database. If this is not where you would like your modeled Stripe data to be written to, add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
models:
  stripe:
    +schema: my_new_schema_name # leave blank for just the target_schema
  stripe_source:
    +schema: my_new_schema_name # leave blank for just the target_schema

Read more about using custom schemas in dbt here.

Running on Live vs Test Customers

By default, this package will run on non-test data (where livemode = true) from the source Stripe tables. However, you may want to include and focus on test data when testing out the package or developing your analyses. To run on only test data, add the following configuration to your dbt_project.yml file:

# dbt_project.yml

vars:
    stripe_source:
        using_livemode: false  # Default = true

Including sub Invoice Line Items

By default, this package will filter out any records from the invoice_line_item source table which include the string sub_. This is due to a legacy Stripe issue where sub_ records were found to be duplicated. However, if you highly utilize these records you may wish they be included in the final output of the stg_stripe__invoice_line_item model. To do, so you may include the below variable configuration:

# dbt_project.yml

vars:
    stripe_source:
        using_invoice_line_sub_filter: false # Default = true

Pivoting out Metadata Properties

By default, this package selects the metadata JSON field within the customer, charge, invoice, payment_intent, payment_method, payout, plan, refund, and subscription source tables. However, you likely have properties within the metadata JSON field you would like to pivot out and include in the respective downstream staging model.

If there are properties in the metadata JSON field that you'd like to pivot out into columns, add the respective variable(s) to your dbt_project.yml file:

# dbt_project.yml

vars:
    stripe__charge_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__invoice_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__payment_intent_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__payment_method_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__payout_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__plan_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__refund_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__subscription_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON
    stripe__customer_metadata: ['the', 'list', 'of', 'property', 'fields'] # Note: this is case-SENSITIVE and must match the casing of the property as it appears in the JSON

Setting your timezone

This packages leaves all timestamp columns in the UTC timezone. However, there are certain instances, such in the daily overview model, that timestamps have to be converted to dates. As a result, the timezone used for the timestamp becomes relevant.

By default, this package will use the UTC timezone when converting to date, but if you want to set the timezone to the time in your Stripe reports, add the following configuration to your dbt_project.yml:

# dbt_project.yml

...
vars:
  stripe_timezone: "America/New_York" # Replace with your timezone

Contributions

Additional contributions to this package are very welcome! Please create issues or open PRs against main. Check out this post on the best workflow for contributing to a package.

Database support

This package has been tested on BigQuery, Snowflake, Postgres, and Redshift.

Resources:

Provide feedback on our existing dbt packages or what you'd like to see next
Have questions, feedback, or need help? Book a time during our office hours using Calendly or email us at solutions@fivetran.com
Find all of Fivetran's pre-built dbt packages in our dbt hub
Learn how to orchestrate your models with Fivetran Transformations for dbt Core™
Learn more about Fivetran overall in our docs
Check out Fivetran's blog
Learn more about dbt in the dbt docs
Check out Discourse for commonly asked questions and answers
Join the chat on Slack for live discussions and support
Find dbt events near you
Check out the dbt blog for the latest news on dbt's development and best practices

TonyLLondon / dbt_stripe