Skip to content

docs(tax): TAX-1750 add store operations docs for tax customers and tax property type field #929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

declankirk
Copy link
Contributor

@declankirk declankirk commented May 2, 2025

TAX-1750

What changed?

  • Adding documentation for the new /v3/tax/customers endpoint, for configuring customer tax data (currently just tax_properties)
  • Adding new tax properties type field to dictate whether property is associated to PRODUCT or CUSTOMER

Release notes draft

  • Added a new optional type field to tax properties, allowing you to specify whether a property is associated with a product or a customer. If not set, it will default to PRODUCT.
  • Added new /v3/tax/customers endpoint for managing customer tax data. Supports the following operations:
    • GET: Retrieve tax data for one or more customers.
    • PUT: Add or update tax properties for customers.
    • DELETE: Remove tax data for specified customers.

Anything else?

ping @bigcommerce/team-tax

@declankirk declankirk force-pushed the TAX-1750-mdx branch 2 times, most recently from 5211351 to 5652d1e Compare May 2, 2025 01:40
@declankirk declankirk marked this pull request as ready for review May 2, 2025 03:09
@declankirk declankirk requested a review from a team May 2, 2025 03:23

The Tax Properties API allows merchants to vary the tax information they send to tax providers for tax calculation. In some jurisdictions, tax rates for products vary by product composition. For example, accurate taxation of alcohol may require information about alcohol percentage. Using tax properties, providers can return more accurate tax quotes. The examples in this guide expand on this use case.
The Tax Properties API allows merchants to vary the tax information they send to tax providers for tax calculation. In some jurisdictions, tax rates for products vary by product composition. For example, accurate taxation of alcohol may require information about alcohol percentage. Using tax properties, providers can return more accurate tax quotes. The examples in this guide expand on this use case.

Tax providers may sometimes need multiple inputs that can vary between different types of product. For example, for products with alcohol, the alcohol percentage and the volume sold affect alcohol taxes. As shown in this guide, merchants can provide both pieces of information to tax providers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above, I think we can drop this paragraph - it's largely a repeat and seems to only be pointing out that users can have multiple product tax properties.


The Tax Properties API allows merchants to vary the tax information they send to tax providers for tax calculation. In some jurisdictions, tax rates for products vary by product composition. For example, accurate taxation of alcohol may require information about alcohol percentage. Using tax properties, providers can return more accurate tax quotes. The examples in this guide expand on this use case.
The Tax Properties API allows merchants to vary the tax information they send to tax providers for tax calculation. In some jurisdictions, tax rates for products vary by product composition. For example, accurate taxation of alcohol may require information about alcohol percentage. Using tax properties, providers can return more accurate tax quotes. The examples in this guide expand on this use case.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍻 Now that we're talking about two types of tax properties, I think it makes sense to shuffle some of this around and go even more high-level...

Suggested change
The Tax Properties API allows merchants to vary the tax information they send to tax providers for tax calculation. In some jurisdictions, tax rates for products vary by product composition. For example, accurate taxation of alcohol may require information about alcohol percentage. Using tax properties, providers can return more accurate tax quotes. The examples in this guide expand on this use case.
The Tax Properties API allows merchants to vary the tax information they send to tax providers for tax calculation.
In some jurisdictions, tax rates for products vary by product composition. For example, accurate taxation of alcohol may require information about alcohol percentage. Using product tax properties, providers can return more accurate tax quotes.
Tax calculation may also be influenced by customer data that sits outside the standard BigCommerce customer model. For example, a tax provider may provide a tax exemption based on exemption certificates associated with third party ERP customer ID. Using customer tax properties, providers can apply the relevant adjustments to the transacting customer's tax quote.
The examples in this guide expand on these product and customer use cases.


Tax providers may sometimes need multiple inputs that can vary between different types of product. For example, for products with alcohol, the alcohol percentage and the volume sold affect alcohol taxes. As shown in this guide, merchants can provide both pieces of information to tax providers.

The API also supports **customer tax properties**, which allow merchants to provide customer-specific tax information to tax providers. These properties can influence how tax is calculated based on the customer making the purchase.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍻 See above 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants