Tax Settings API: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Display prices correctly based on tax settings

An app that displays product prices needs to know whether catalog prices already include tax, so it can present totals correctly to customers. If prices are tax-exclusive, the app needs to calculate and add the applicable tax before displaying them.

To display prices correctly based on tax settings:

1. Call Get Tax Settings to retrieve the site's tax settings.
2. Check the value of taxIncludedInItemPrices in the response.
3. If taxIncludedInItemPrices is true, display catalog prices as tax-inclusive. If false, calculate and add the applicable tax to catalog prices before displaying them.

Update tax settings when a merchant configures their pricing

A merchant uses a settings page in the dashboard to specify whether their catalog prices already include tax. When the merchant saves their preference, your app updates the site's tax settings accordingly.

To update tax settings when a merchant configures their pricing:

1. Collect the merchant's preference for whether catalog prices include tax.
2. Call Upsert Tax Settings with taxIncludedInItemPrices set to the merchant's chosen value. If tax settings don't exist for the site yet, this method creates them. Otherwise, it updates the existing settings.
3. Confirm to the merchant that the settings have been saved. The updated settings take effect immediately for all Wix products on the site.