PHPackages ejosterberg/opensalestax-woocommerce - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ejosterberg/opensalestax-woocommerce Abandoned → [ejosterberg/opensalestax-for-woocommerce](/?search=ejosterberg%2Fopensalestax-for-woocommerce)Wordpress-plugin[Utility & Helpers](/categories/utility) ejosterberg/opensalestax-woocommerce ==================================== WooCommerce plugin: replace TaxJar/Avalara with self-hosted OpenSalesTax — destination-based US sales tax at checkout. v0.7.1(3w ago)017Apache-2.0PHPPHP >=8.2CI passing Since May 5Pushed 3w agoCompare [ Source](https://github.com/ejosterberg/opensalestax-for-woocommerce)[ Packagist](https://packagist.org/packages/ejosterberg/opensalestax-woocommerce)[ Docs](https://github.com/ejosterberg/opensalestax-for-woocommerce)[ RSS](/packages/ejosterberg-opensalestax-woocommerce/feed)WikiDiscussions main Synced 1w ago READMEChangelog (10)Dependencies (5)Versions (23)Used By (0) OpenSalesTax for WooCommerce ============================ [](#opensalestax-for-woocommerce) > Replace TaxJar / Avalara / WooCommerce Tax with self-hosted [OpenSalesTax](https://github.com/ejosterberg/open-sales-tax). Free, open-source, US sales-tax calculation at WooCommerce checkout. [![License](https://camo.githubusercontent.com/10760b022884ece8580de61e0245411f61031feac076e9f17afcefbbdf0ddb64/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d417061636865253230322e302532304f5225323047504c253230322e302532422d626c7565)](LICENSE) [![PHP](https://camo.githubusercontent.com/184ea983600c41146ee84f2391d4841a638528091c0262f5e51738e676897fad/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d254532253839254135382e322d373737626234)](composer.json) [![WordPress](https://camo.githubusercontent.com/8a08918dce8921c6007b9831f2708e387041e2090d4e2bc5e3f7806618ad51f6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f776f726470726573732d254532253839254135362e322d323137353962)](readme.txt) [![WooCommerce](https://camo.githubusercontent.com/b251e68140c6bdaa9b577e5a527eeb7f8fe0d4937349059da92b35e994e89f31/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f776f6f636f6d6d657263652d254532253839254135382e322d393635383861)](readme.txt) **Status:** v0.4.1. Tested against WordPress 6.6+ / WooCommerce 10.7 / OpenSalesTax engine v0.39. 109 unit tests + an end-to-end integration test on a real WP+WooCom Proxmox VM. What this saves you ------------------- [](#what-this-saves-you) Most WooCommerce tax plugins are paid services or limited free tiers: ServicePricing model**WooCommerce Tax** (Jetpack)Free up to 200 transactions/mo; paid tier above**TaxJar**from $19/mo + transaction fees**Avalara AvaTax**enterprise pricing**OpenSalesTax + this plugin**$0 software cost, self-hostedYou run a small VM (or container) for the OpenSalesTax engine; this plugin calls into it from WC's checkout flow. Tax math runs locally on infrastructure you own. Install ------- [](#install) ``` cd /path/to/your/wordpress/wp-content/plugins/ git clone https://github.com/ejosterberg/opensalestax-for-woocommerce.git cd opensalestax-for-woocommerce composer install --no-dev ``` Activate via **WP Admin → Plugins**. Or via Composer: ``` composer require ejosterberg/opensalestax-for-woocommerce ``` The SDK ([`ejosterberg/opensalestax`](https://packagist.org/packages/ejosterberg/opensalestax)) and the plugin ([`ejosterberg/opensalestax-for-woocommerce`](https://packagist.org/packages/ejosterberg/opensalestax-for-woocommerce)) are both on Packagist. For the full step-by-step walkthrough including engine setup, configuration, and verification, see [`docs/INSTALL.md`](docs/INSTALL.md). Configure --------- [](#configure) 1. Stand up an OpenSalesTax engine ([5-minute Docker quickstart](https://github.com/ejosterberg/open-sales-tax)) 2. In WP Admin: **WooCommerce → Settings → Tax → OpenSalesTax** 3. Enter your engine's base URL (e.g. `http://your-engine:8080`) 4. (Optional) Enter API key if your engine has authentication enabled 5. Click **Test Connection** — should report `status: ok` with the engine version Done. The next cart that includes a US shipping address gets destination-based sales tax. How it works ------------ [](#how-it-works) The plugin hooks WooCommerce's `woocommerce_calc_tax` filter. On every line that needs tax computed: 1. Read the customer's shipping ZIP from `WC()->customer` 2. Resolve the line's tax category (WC tax class → OpenSalesTax category) 3. Skip if customer is tax-exempt (`WC()->customer->is_vat_exempt()`) 4. Look up cached tax for `(zip, category, line-amount)` — return early on hit 5. On cache miss, call `POST /v1/calculate` on your OpenSalesTax engine 6. Return the calculated tax amount in WC's expected format Tax breakdown (per-state, per-county, per-city, per-district) is computed and returned by the engine. The combined total flows into WC's tax line; per-jurisdiction detail can be inspected via `wp opensalestax calc `. Design choices -------------- [](#design-choices) - **Replace, not populate.** This plugin replaces WC's tax calculation entirely via the filter. WC's `wp_woocommerce_tax_rates` table is ignored. Single source of truth = your OpenSalesTax engine. No DB sync drift. - **Tax-exempt customers** are honored via `WC()->customer->is_vat_exempt()`. The exempt flag short-circuits before the engine call. - **Caching** uses WP transients with a default 60-minute TTL. Configurable. Bulk-flushed on settings save. - **Error handling** is graceful: if the engine is unreachable, you choose between blocking (no tax line, transaction fails until config is fixed) or zero (charge $0 tax, log via WC error log). Default = block. Compatibility ------------- [](#compatibility) - **WordPress** 6.2+ (Blocks-stable) - **WooCommerce** 8.2+ (security-supported) - **PHP** 8.2+ (uses class-level `readonly` syntax via the OpenSalesTax SDK) - **OpenSalesTax engine** v0.22+ (recommended — a state-bleed bug was fixed in v0.22) Compatible with **classic checkout AND Cart/Checkout Blocks** (Blocks invoke the same `woocommerce_calc_tax` filter via the Store API). HPOS-compatible: this plugin doesn't post-process orders in v0.1, so the HPOS tax-reading caveat doesn't apply. What's shipping --------------- [](#whats-shipping) - ✅ **Refund handling** (v0.4.1) — when you issue a refund (full or partial), the refund order's admin page shows a prorated per-jurisdiction tax breakdown with negative values. Math: `parent_breakdown × (refund_total / parent_total) × -1`. No engine round-trip needed. - ✅ **Engine-unreachable admin notice** (v0.4.1) — every WP-admin page renders a red banner when the OpenSalesTax engine is down or misconfigured. Closes the silent-failure gap where merchants could collect wrong tax for days without realizing. - ✅ **WooCommerce Subscriptions integration** (v0.4.0) — renewal orders get a fresh tax recalc against current rates instead of inheriting the parent sub's stale tax line. Per-jurisdiction breakdown captured on the renewal too. No-op without WC Subscriptions installed. - ✅ **Admin-UI tax-class mapper** (v0.3.3) — replaces the CLI-only configuration with a UI under WC > Settings > Tax > OpenSalesTax. Auto-discovers all WC tax classes (built-in + custom), shows a dropdown per row, includes a "Reset all to defaults" checkbox. - ✅ **Recent-calculations debug log** (v0.3.2) — opt-in 50-entry ring buffer captures every cart calculation (cache-hit / engine-call / error) with timing, ZIP, category, amount, tax. Viewable via `wp opensalestax recent-calcs` or a panel on the settings page. Useful when troubleshooting "why is this tax wrong?" - ✅ **Status dashboard widget** (v0.3.1) — WP-admin home page shows engine reachability, version, placeholder-rate state, and today's order count with breakdown captured. 60-second transient cache keeps the engine from getting hammered. - ✅ **Per-order jurisdiction breakdown** (v0.3) — every order stores the engine's full state/county/city/district split as meta and renders a clean table on the WC admin order-edit page. Useful for audit reconciliation and answering "where did my tax money go?" - ✅ **WC Tax Class custom mapping** (v0.2) — map `clothing`, `groceries`, or any custom WC class to the right OST category (or mark non-taxable). Built-in defaults still apply for `standard`/`reduced-rate`/`zero-rate`. Configure via `wp opensalestax tax-class-list / tax-class-set / tax-class-reset`. - ✅ **WP-CLI** commands — `test-connection`, `cache-flush`, `calc `, `placeholder-rate`, `tax-class-list`, `tax-class-set`, `tax-class-reset` - ✅ **SSRF mitigation** (v0.1.2) — engine base URL validated against private/loopback/CGNAT ranges (opt-in for LAN deployments) - ✅ **Tax-line aggregation fix** (v0.1.1) — `WC_Cart::get_tax_totals()` correctly labels the line as "OpenSalesTax" via the placeholder rate row What's coming next ------------------ [](#whats-coming-next) - **WP.org plugin directory** submission (planned after launch traction) - More commerce platforms (Stripe Tax replacement, Magento, Saleor, Medusa, ERPNext, Odoo) under the OpenSalesTax umbrella project Out of scope ------------ [](#out-of-scope) - **Multi-currency** carts — engine is USD-only; non-USD throws - **Stripe Connect** / multi-vendor marketplace tax allocation - **Per-product** custom tax-code overrides - **Tax filing / remittance** — calculation only, by design (engine constitution §13) Disclaimer ---------- [](#disclaimer) > Tax calculations are provided as-is for convenience. The merchant is solely responsible for tax-collection accuracy and remittance to the appropriate jurisdictions. Verify against your state Department of Revenue before remitting. Quality bar ----------- [](#quality-bar) - **PHPStan level=max** — zero suppressed errors - **PHP-CS-Fixer** with PSR-12 + risky rules — zero violations - **PHPUnit** unit tests against fixtures + integration tests against a real WP+WooCom instance - **GitHub Actions CI** matrix on PHP 8.2 / 8.3 / 8.4 Contributing ------------ [](#contributing) DCO sign-off (`git commit -s`) required on every commit. See [CONTRIBUTING.md](CONTRIBUTING.md). License ------- [](#license) Dual-licensed: **Apache-2.0 OR GPL-2.0-or-later** — recipient picks. See [`LICENSE`](LICENSE), [`LICENSE-APACHE.txt`](LICENSE-APACHE.txt), and [`LICENSE-GPL.txt`](LICENSE-GPL.txt). The GPL-2.0-or-later option exists primarily for WordPress.org plugin directory compatibility; most merchants embedding the plugin in their own WooCommerce deployment will be served by the Apache-2.0 option. ### Health Score 41 — FairBetter than 87% of packages Maintenance95 Actively maintained with recent releases Popularity8 Limited adoption so far Community6 Small or concentrated contributor base Maturity45 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 22 Last Release 21d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b647ae9c341fdf92c36cb479ba7535c2eff9ac92f8614965a3b5953f7b543152?d=identicon)[ejosterberg](/maintainers/ejosterberg) --- Top Contributors [![ejosterberg](https://avatars.githubusercontent.com/u/6363457?v=4)](https://github.com/ejosterberg "ejosterberg (33 commits)") --- Tags avalara-alternativeopensalestaxphpsales-taxtaxtaxjar-alternativewoocommercewordpress-pluginwordpresswoocommercetaxsales taxopensalestaxus-tax ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/ejosterberg-opensalestax-woocommerce/health.svg) ``` [![Health](https://phpackages.com/badges/ejosterberg-opensalestax-woocommerce/health.svg)](https://phpackages.com/packages/ejosterberg-opensalestax-woocommerce) ``` ### Alternatives [php-stubs/woocommerce-stubs WooCommerce function and class declaration stubs for static analysis. 953.3M90](/packages/php-stubs-woocommerce-stubs)[woocommerce/woocommerce-sniffs WooCommerce sniffs 497.3M49](/packages/woocommerce-woocommerce-sniffs)[bootscore/bootscore A powerful, free Bootstrap 5 starter theme for WordPress. 3752.7k](/packages/bootscore-bootscore) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)