Skip to content

Latest commit

 

History

History
268 lines (212 loc) · 18.2 KB

CHANGELOG.md

File metadata and controls

268 lines (212 loc) · 18.2 KB
Raw

dbt_stripe v0.14.0

PR #82 includes the following updates:

Feature Updates

  • Addition of the stripe__line_item_enhanced model. This model constructs a comprehensive, denormalized analytical table that enables reporting on key revenue, subscription, customer, and product metrics from your billing platform. It’s designed to align with the schema of the *__line_item_enhanced model found in Stripe, Recharge, Recurly, Shopify, and Zuora, offering standardized reporting across various billing platforms. To see the kinds of insights this model can generate, explore example visualizations in the Fivetran Billing Model Streamlit App. Visit the app for more details.
    • This model is currently disabled by default. You may enable it by setting the stripe__standardized_billing_model_enabled as true in your dbt_project.yml.

Relevant Upstream Updates (dbt_stripe_source v0.12.0)

  • Addition of the following new staging models and accompanying upstream references:
    • stg_stripe__discount (required for downstream dbt_stripe model transformations)
    • stg_stripe__product (enabled by default, but can be disabled by setting the stripe__using_subscriptions variable to false)

Under the Hood

  • Added consistency test within integration_tests for the stripe__line_item_enhanced model.
  • Updated the quickstart.yml to include the product source table as a requirement for the stripe__using_subscriptions variable.

dbt_stripe v0.13.0

PR #78 includes the following updates:

🚨 Breaking Changes 🚨

  • Renamed folder stripe_reports to stripe_financial_reports to be more descriptive of the contents.
    • ⚠️ If you are using folder names to scope out configs, runs, etc., you will need to update the folder name.

Bug fixes

  • Updated model int_stripe__date_spine to accommodate cases when model stripe__balance_transactions has no records.
    • Previously, the date spine relied on stripe__balance_transactions to set date bounds, which caused errors if empty. Now, the model defaults to a one-month range in such cases.

Under the hood

  • Updated structure of model int_stripe__date_spine for improved performance and maintainability.

dbt_stripe v0.12.0

PR #75 includes the following updates:

🚨 Breaking Changes 🚨

  • No longer filters out deleted customers in stripe__customer_overview.
    • Persists is_deleted field to differentiate between deleted and active customers.
    • Note that this is a 🚨 breaking change 🚨, as previously filtered-out records will appear in stripe__customer_overview.

Feature Updates

  • Adds the phone column to stripe__customer_overview.

Under the Hood

  • Included auto-releaser GitHub Actions workflow to automate future releases.
  • Updated the maintainer PR template to resemble the most up to date format.

dbt_stripe v0.11.0

PR #69 contains the following updates:

🚨 Breaking Changes 🚨

  • Prefixed the following fields based on their corresponding upstream source to maintain clarity:
Previous Name New Name
created_at balance_transaction_created_at
available_on balance_transaction_available_on
currency balance_transaction_currency
amount balance_transaction_amount
fee balance_transaction_fee
net balance_transaction_net
type balance_transaction_type
source balance_transaction_source_id
reporting_category balance_transaction_reporting_category
description balance_transaction_description

Updates:

  • Introduced the following new models, named after the Stripe reports that they follow. These models help reproduce reports available in the Stripe Reporting API. The reports introduced in this update include:

    • stripe__activity_itemized_2
    • stripe__balance_change_from_activity_itemized_3
    • stripe__ending_balance_reconciliation_itemized_4
    • stripe__payout_itemized_3

  • Updated the stripe__balance_transactions with the following changes:

    • reporting_category has been updated to pull directly from the titular column. If no reporting_category exists, it then falls to sort based on balance transaction type in accordance to the Stripe documentation.
    • Added the following fields:
      • dispute fields
      • transfer fields
      • additional payout fields
      • additional customer fields
      • additional card fields
      • additional charge fields
      • additional invoice fields
    • Updated customer_facing_amount to include for refunds and disputes as well
    • Updated charge_id to charge, refund, then dispute objects consecutively

Under the Hood:

  • Incorporated the new fivetran_utils.drop_schemas_automation macro into the end of each Buildkite integration test job.
  • Updated the pull request templates.

dbt_stripe v0.10.1

PR #61 contains the following changes:

Documentation Updates

  • Updated the Metadata pivot documentation to be more clear that these variables only affect the dbt_stripe_source staging models.
  • Added reference to the new stripe__card_metadata and stripe__invoice_line_item_metadata metadata variables that are available in the latest source package update.

Under the Hood

  • Updated the card and invoice_line_item seed files to be consistent with the source package versions. Specifically to include the metadata fields.
  • Added a new BuildKite run statement to test a few of the metadata variables.

Upstream Changes

  • See the source package CHANGELOG for updates made to the staging layer in dbt_stripe_source v0.9.1.

dbt_stripe v0.10.0

#60 includes the following changes:

🚨 Breaking Changes 🚨:

  • Unwrapped total_* fields from the for loop in stripe__daily_overview to reduce compute required for previous for-loops
  • Add account_id in int_stripe__account_rolling_totals for use as part of the join in the case where more than 1 account_id exists.

Under the Hood

  • Intermediate model materializations have changed from ephemeral to table to reduce the compute required for the complexity of calculations.

dbt_stripe v0.9.0

#56 includes the following changes:

🚨 Breaking Changes 🚨:

  • stripe__subscription_line_items has been removed. To recreate it, simply filter stripe__invoice_line_items for where subscription_id is not null.
  • The stripe__weekly_overview, stripe__quarterly_overview, and stripe__monthly_overview models have been removed as they can be recreated directly from the stripe__daily_overview by rolling up the date grain.
  • The stripe__invoice_line_item and stripe__subscription_line_items have been renamed to stripe__invoice_line_item_details and stripe__subscription_details.
  • Following the addition of the new pricing source table which may replace the plan table depending on whether you migrated to the Price API (Stripe doc here.), the following columns in stripe__invoice_line_items have been updated. This package will draw the respective columns from the price object by default if it exists. However, if you still have and wish to keep using plan, you can set stripe__using_price to False. For more please see the README
Previous Name New Name
plan_is_active price_plan_is_active
plan_amount price_plan_amount
plan_interval price_plan_interval
plan_interval_count price_plan_interval_count
plan_nickname price_plan_nickname
plan_product_id price_plan_product_id

  • In addition, stripe__plan_metadata variable has been renamed to stripe__price_plan_metadata

  • Stripe connectors set up after February 09, 2022 will use the subscription_history table, as they will no longer be syncing the subscription table. This package uses subscription_history by default if it exists. However, if you still have the subscription table and wish to use it instead, then set the stripe__using_subscription_history to False.

  • Variables have been prefixed with stripe__ so they can be used globally.

Previous Name New Name
using_invoices stripe__using_invoices
using_credit_notes stripe__using_credit_notes
using_payment_method stripe__using_payment_method
using_livemode stripe__using_livemode
using_invoice_line_sub_filter stripe__using_invoice_line_sub_filter
using_subscriptions stripe__using_subscriptions
using_subscription_history stripe__using_subscription_history
using_price stripe__using_price
  • In the stripe__subscription_details model, start_date has been updated to start_date_at to follow our standard naming practices.

🎉 Feature Updates 🎉

  • Introducing the new model stripe__invoice_details.
  • Updated the models stripe__daily_overview with additional daily and rolling metrics.
  • subscription_item_id has been added to the stripe__invoice_line_items model.
  • Added the ability to union datasets across different schemas or databases. A new column populating each model called source_relation will specify the source of each record.

For more information please refer to the README and stripe.yml

dbt_stripe v0.8.0

🚨 Breaking Changes 🚨:

PR #48 includes the following breaking changes:

  • Dispatch update for dbt-utils to dbt-core cross-db macros migration. Specifically {{ dbt_utils.<macro> }} have been updated to {{ dbt.<macro> }} for the below macros:
    • any_value
    • bool_or
    • cast_bool_to_text
    • concat
    • date_trunc
    • dateadd
    • datediff
    • escape_single_quotes
    • except
    • hash
    • intersect
    • last_day
    • length
    • listagg
    • position
    • replace
    • right
    • safe_cast
    • split_part
    • string_literal
    • type_bigint
    • type_float
    • type_int
    • type_numeric
    • type_string
    • type_timestamp
    • array_append
    • array_concat
    • array_construct
  • For current_timestamp and current_timestamp_in_utc macros, the dispatch AND the macro names have been updated to the below, respectively:
    • dbt.current_timestamp_backcompat
    • dbt.current_timestamp_in_utc_backcompat
  • Dependencies on fivetran/fivetran_utils have been upgraded, previously [">=0.3.0", "<0.4.0"] now [">=0.4.0", "<0.5.0"].
  • Updated README to include instructions on how to use metadata variable in cases of dictionary arguments. (#51)

dbt_stripe v0.7.4

🎉 Feature Updates

  • Included the subscription_item_id field within the stripe__invoice_line_items model. (#50)
  • BuildKite testing has been added. (#52)

Contributors

dbt_stripe v0.7.3

🎉 Feature Updates

  • Included the currency field within the stripe__invoice_line_items model. (#44)

Contributors

dbt_stripe v0.7.2

🎉 Feature Updates

  • Databricks compatibility 🧱 (#44)

dbt_stripe v0.7.1

Feature Updates 🎉

  • README updates for easier package navigation and understanding. (#41)

Under the Hood

  • Updating the package dependency to reference the proper [">=0.7.0", "<0.8.0"] version range of dbt_stripe_source. (#41)

dbt_stripe v0.7.0

🚨 Breaking Changes 🚨

  • Stripe connectors set up after February 09, 2022 no longer sync the subscription table; however, a newer subscription_history table is synced. To account for this change a variable stripe__subscription_history has been added to the package project to allow for users to define if their source contains the subscription_history table. (#37)
    • By default this variable is set to false. If you still have the subscription table, then there is no adjustment needed on your end. If you do have the subscription_history table then you will want to set the variable to true.
    • Similarly, if you have both tables, then I highly encourage you start leveraging the subscription_history source table in your package.
    • This package now points to the latest dbt_stripe_source package version which accounts for the above update. (#33 and #34)

🐞 Bug Fixes 🐞

  • #35: Fix issue with timezone conversion in postgres by updating the date_timezone macro with postgres functionality. @johnf
  • Added Postgres support for the Stripe package.
  • See PR #37

Contributors

dbt_stripe v0.6.1

🐞 Bug Fixes 🐞

  • #24: Updating docs to add dbt_stripe documentation in addition to dbt_stripe_source documentation.
  • #27: Updating models/stripe__customer_overview.sql to use max instead of min for calculating most_recent_sale_date.
  • #28: Updating models/stripe__customer_overview.sql to include "No Associated Customer" records.
    • This PR accounts for when a transaction may be tied to a customer_id that has not yet synced into the customers table due primarily due to a sync lapse between the tables; in which case, the customer_description field will be "No Associated Customer".
    • Each "No Associated Customers" record will be an individual row, since we can not predictably do any group bys due to the stripe__customer_metadata variable variability in both datatype and number of metadata fields.

dbt_stripe v0.6.0

🎉 dbt v1.0.0 Compatibility 🎉

🚨 Breaking Changes 🚨

  • Adjusts the require-dbt-version to now be within the range [">=1.0.0", "<2.0.0"]. Additionally, the package has been updated for dbt v1.0.0 compatibility. If you are using a dbt version <1.0.0, you will need to upgrade in order to leverage the latest version of the package.
    • For help upgrading your package, I recommend reviewing this GitHub repo's Release Notes on what changes have been implemented since your last upgrade.
    • For help upgrading your dbt project to dbt v1.0.0, I recommend reviewing dbt-labs upgrading to 1.0.0 docs for more details on what changes must be made.
  • Upgrades the package dependency to refer to the latest dbt_stripe_source. Additionally, the latest dbt_stripe_source package has a dependency on the latest dbt_fivetran_utils. Further, the latest dbt_fivetran_utils package also has a dependency on dbt_utils [">=0.8.0", "<0.9.0"].
    • Please note, if you are installing a version of dbt_utils in your packages.yml that is not in the range above then you will encounter a package dependency error.

dbt_stripe v0.5.1

Features

  • Add functionality to include customer metadata in stripe__customer_overview. (#21) The customer metadata is passed in from the stg_stripe__customer model in the Stripe source package.

dbt_stripe v0.1.0 -> v0.5.0

  • Refer to the relevant release notes on the Github repository for specific details for the previous releases. Thank you!