Collect taxes
Use Stripe Tax to calculate and collect taxes in your custom integration with Elements.
Stripe Tax APIs enable you to calculate tax in custom payment flows. After your customer completes their payment, record the transaction so it appears in Stripe Tax reporting. The examples in this guide use Stripe payments APIs, but you can use the Tax API with any payment processor, or multiple payment processors.
For most integrations, we recommend using the Checkout Sessions API with Stripe Tax.
Alternatively, you can integrate Stripe Tax with Payment Links, Checkout, Billing, and Invoicing with no or low code setups.
Stripe Tax APIs enable you to calculate tax in custom payment flows. After your customer completes their payment, record the transaction so it appears in Stripe Tax reporting. The examples in this guide use Stripe payments APIs, but you can use the Tax API with any payment processor, or multiple payment processors.
If your custom payment flow uses the Payment Intents API, see Calculate tax in your custom payment flows. This integration is in public preview and offers receipts and Dashboard support.
Alternatively, you can integrate Stripe Tax with Payment Links, Checkout, Billing, and Invoicing with no or low code setups.
Get started
This short video walks through a Stripe Tax API integration that uses the Payment Intents API and the Payment Element.
Add registrations
Stripe Tax only calculates tax in jurisdictions where you’re registered to collect tax. You must add your registrations in the Dashboard.
OptionalCollect customer addressClient-side
The tax you collect typically depends on your customer’s location. For the most accurate tax calculation, collect your customer’s full address. Before collecting an address, you can show your customer an estimate based on their IP address.
Note
The examples below use a simple custom address form, but you can also use the Address Element to collect addresses from customers with autocomplete and localization features.
The form below collects a full postal address:
<form> <label for="address_line1">Address Line 1</label> <input type="text" id="address_line1" /> <label for="address_city">City</label> <input type="text" id="address_city" /> <label for="address_state">State</label> <select id="address_state"> <option value="WA">Washington</option> <!-- add more states here --> </select> <label for="address_postal_code">Postal code</label> <input type="text" id="address_postal_code" /> <label for="address_country">Country</label> <select id="address_country"> <option value="US">United States</option> <option value="DE">Germany</option> <option value="IE">Ireland</option> <!-- add more countries here --> </select> </form>
You might pass the address to your server endpoint as follows:
const address = { line1: document.getElementById('address_line1').value, city: document.getElementById('address_city').value, state: document.getElementById('address_state').value, postal_code: document.getElementById('address_postal_code').value, country: document.getElementById('address_country').value, }; var response = fetch('/preview-cart', { method: 'POST', body: JSON.stringify({address: address}), headers: {'Content-Type': 'application/json'}, }).then(function(response) { return response.json(); }).then(function(responseJson) { // Handle errors, or display calculated tax to your customer. });
The address information that’s required to calculate tax varies by customer country:
- United States: We require your customer’s postal code at a minimum. We recommend providing a full address for the most accurate tax calculation result.
- Canada: We require your customer’s postal code or province.
- Other countries: We only require your customer’s country code.
Calculate taxServer-side
You choose when and how often to calculate tax. For example, you can:
- Show a tax estimate based on your customer’s IP address when they enter your checkout flow
- Recalculate tax as your customer types their billing or shipping address
- Calculate the final tax amount to collect when your customer finishes typing their address
Stripe charges a fee per tax calculation API call. You can throttle tax calculation API calls to manage your costs.
The examples below show how to calculate tax in a variety of scenarios. Stripe Tax only calculates tax in jurisdictions where you’re registered to collect tax. You must add your registrations in the Dashboard.
The calculation response contains amounts you can display to your customer, and use to take payment:
| Attribute | Description |
|---|---|
| amount_total | The grand total after calculating tax. Use this to set the PaymentIntent amount to charge your customer. |
| tax_amount_exclusive | The amount of tax added on top of your line item amounts and shipping cost. This tax amount increases the amount_. Use this to show your customer the amount of tax added to the transaction subtotal. |
| tax_amount_inclusive | The amount of tax that’s included in your line item amounts and shipping cost (if using tax-inclusive pricing). This tax amount doesn’t increase the amount_. Use this to show your customer the tax included in the total they’re paying. |
| tax_breakdown | A list of tax amounts broken out by country or state tax rate. Use this to show your customer the specific taxes you’re collecting. |
Handle customer location errors
The calculation returns the customer_ error code, if your customer’s address is invalid or isn’t precise enough to calculate tax:
{ "error": { "doc_url": "https://docs.stripe.com/error-codes#customer-tax-location-invalid", "code": "customer_tax_location_invalid", "message": "We could not determine the customer's tax location based on the provided customer address.", "param": "customer_details[address]", "type": "invalid_request_error" } }
If you receive this error, prompt your customer to check the address they entered and fix any typos.
Use calculation with another processor
If you process transactions outside of Stripe, you can skip the following steps and apply the calculation to your externally-processed transactions.
Create tax transactionServer-side
Creating a tax transaction records the tax you’ve collected from your customer, so that later you can download exports and generate reports to help with filing your taxes. You can create a transaction from a calculation until the expires_at timestamp, 90 days after it’s created. Attempting to use it after this time returns an error.
Note
The transaction is considered effective on the date when create_ is called, and tax amounts won’t be recalculated.
When creating a tax transaction, you must provide a unique reference for the tax transaction and each line item. The references appear in tax exports to help you reconcile the tax you collected with the orders in your system.
For example, a tax transaction with reference pi_, line item references L1 and L2, and a shipping cost, looks like this in the itemized tax exports:
| ID | line_item_id | type | currency | transaction_date |
|---|---|---|---|---|
| pi_123456789 | L1 | external | usd | 2023-02-23 17:01:16 |
| pi_123456789 | L2 | external | usd | 2023-02-23 17:01:16 |
| pi_123456789 | shipping | external | usd | 2023-02-23 17:01:16 |
When your customer pays, use the calculation ID to record the tax collected. You can do this in two ways:
- If your server has an endpoint where your customer submits their order, you can create the tax transaction after the order is successfully submitted.
- Listen for the payment_intent.succeeded webhook event. Retrieve the calculation ID from the PaymentIntent
metadata.
The example below creates a transaction and uses the PaymentIntent ID as the unique reference:
Store the tax transaction ID to record refunds later. You can store the transaction ID in your database or in the PaymentIntent’s metadata:
Record refundsServer-side
After creating a tax transaction to record a sale to your customer, you might need to record refunds. These are also represented as tax transactions, with type=reversal. Reversal transactions offset an earlier transaction by having amounts with opposite signs. For example, a transaction that recorded a sale for 50 USD might later have a full reversal of -50 USD.
When you issue a refund (using Stripe or outside of Stripe), you must create a reversal tax transaction with a unique reference. Common strategies include:
- Append a suffix to the original reference. For example, if the original transaction has reference
pi_, then create the reversal transaction with reference123456789 pi_.123456789-refund - Use the ID of the Stripe refund or a refund ID from your system. For example,
re_or3MoslRBUZ691iUZ41bsYVkOg myRefund_.456
Choose the approach that works best for how you reconcile your customer orders with your tax exports.
Fully refund a sale
When you fully refund a sale in your system, create a reversal transaction with mode=full.
In the example below, tax_ is the tax transaction that records the sale to your customer:
This returns the full reversal transaction that’s created:
{ "id": "tax_1MEFtXI6rIcR421e0KTGXvCK", "object": "tax.transaction", "created": 1670866467, "currency": "eur", "customer": null, "customer_details": { "address": { "city": null, "country": "IE",
Fully reversing a transaction doesn’t affect previous partial reversals. When you record a full reversal, make sure you fully reverse any previous partial reversals for the same transaction to avoid duplicate refunds.
Partially refund a sale
After issuing a refund to your customer, create a reversal tax transaction with mode=partial. This allows you to record a partial refund by providing the line item amounts refunded. You can create up to 30 partial reversals for each sale. Reversing more than the amount of tax you collected returns an error.
The example below records a refund of only the first line item in the original transaction:
This returns the partial reversal transaction that’s created:
{ "id": "tax_1MEFACI6rIcR421eHrjXCSmD", "object": "tax.transaction", "created": 1670863656, "currency": "eur", ... "line_items": { "object": "list", "data": [ {
For each line item reversed, you must provide the amount and amount_ reversed. The amount is tax-inclusive if the original calculation line item was tax-inclusive.
How amount and amount_ are determined depends on your situation:
- If your transactions always have a single line item, use full reversals instead.
- If you always refund entire line items, use the original transaction line item
amountandamount_, but with negative signs.tax - If you refund parts of line items, you must calculate the amounts refunded. For example, for a sale transaction with
amount=5000andamount_, after refunding half the line item, you create a partial reversal with line itemtax=500 amount=-2500andamount_.tax=-250
Partially refund a sale by a flat amount
Alternatively, you can create a reversal with mode=partial by specifying a flat after-tax amount to refund. The amount distributes across each line item and shipping cost proportionally, depending on the remaining amount left to refund on each.
In the example below, the transaction has two line items: one 10 USD item and one 20 USD item, both taxed at 10%. The total amount of the transaction is 33.00 USD. A refund for a flat 16.50 USD is recorded:
This returns the partial reversal transaction that’s created:
{ "id": "tax_1NVcQYBUZ691iUZ4SBPukGa6", "object": "tax.transaction", "created": 1689780994, "currency": "usd", ... "line_items": { "object": "list", "data": [ {
For each line item and shipping cost in the original transaction, the refunded amounts and tax are calculated as follows:
- First, we calculate the total remaining funds in the transaction available to refund. Because this transaction hasn’t had any other reversals recorded, the total amount is 33.00 USD.
- Next, we calculate the total amount to refund for each line item. We base this calculation on the proportion of the item’s total available amount to refund versus the total remaining amount of the transaction. For example, the 10 USD item, which has 11.00 USD total remaining to refund, represents 33.33% of the transaction’s remaining total, so the total amount to refund is
-16..50 USD * 33. 33% = -5. 50 USD - Finally, the total amount to refund is divided between
amountandamount_. We also do this proportionally, depending on how much tax is available to refund in the line item compared to the total funds left to refund. Using the 10 USD item example, tax (1.00 USD) represents 9.09% of the total remaining to refund (11.00 USD), so thetax amount_istax -5..50 USD * 9. 09% = -0. 50 USD
The flat amount distributes according to what’s left to refund in the transaction, not what was originally recorded. For example, instead of recording a refund for a flat 16.50 USD, you first record a partial reversal for the total amount of the 10 USD item:
After this, you record a 16.50 USD flat amount reversal:
This returns the partial reversal transaction:
{ "id": "tax_1NVxFIBUZ691iUZ4saOIloxB", "object": "tax.transaction", "created": 1689861020, "currency": "usd", ... "line_items": { "object": "list", "data": [ {
Because the total amount remaining in the transaction is now 22.00 USD and the 10 USD item is completely refunded, the 16.50 USD distributes entirely to the 20 USD item. The 16.50 USD then distributes, using the logic from step 3, into amount = -15. and amount_. Meanwhile, the 10 USD item in the transaction records a refund of 0 USD.
Undo a partial refund
Tax transactions are immutable, but you can cancel a partial refund by creating a full reversal.
You might need to do this when:
- The payment refund fails and you haven’t provided the good or service to your customer
- The wrong order is refunded or the wrong amounts are refunded
- The original sale is fully refunded and the partial refunds are no longer valid
In the example below, tax_ is the transaction that represents the partial refund:
This returns the full reversal transaction that’s created:
{ "id": "tax_1MEFADI6rIcR421e94fNTOCK", "object": "tax.transaction", "created": 1670863657, "currency": "eur", ... "line_items": { "object": "list", "data": [ {
Testing
Use sandboxes, which is identical in response structure to live mode, to confirm your integration works correctly before going live.
Warning
In testing environments, calculations aren’t guaranteed to return up-to-date taxation results. You’re limited to 1,000 tax calculations per day. If you need a higher limit, contact Stripe support. For guidance on automated testing and strategies to avoid rate limits in testing environments, see Automated testing.
View tax transactions
You can view all tax transactions for your account on the Tax Transactions page in the Dashboard. Click an individual transaction to see a detailed breakdown of calculated tax by jurisdiction, and by the individual products included in the transaction.
Note
The Tax Transactions page only includes transactions and not calculations. If you expect to see a calculation and can’t find it on this page, verify that you successfully created a tax transaction from the calculation.
OptionalIntegration examples
You can calculate tax for your customer before collecting payment method details and creating a PaymentIntent. For example, you can display a shopping cart total when the customer provides their postal code.
In the example below, your server defines a /preview-cart endpoint, where the customer’s address is sent from your client-side form. The server combines the cart’s line items and the customer’s address to calculate tax.
When you’re ready to take payment, create a PaymentIntent from the tax calculation result. Store the tax calculation ID in the PaymentIntent’s metadata or in your own database, so you can create a tax transaction when your customer completes payment.
The example below shows a server endpoint that calculates tax, creates (or updates) a PaymentIntent, and returns the result to the client. You can then display the tax to your customer. Use the client_ to take the payment.
If your integration uses the Payment Element, fetch updates from the server after updating the PaymentIntent.
OptionalCalculate tax on shipping costsServer-side
To calculate tax on shipping costs, use the shipping_ parameter:
Pass the ID of an existing ShippingRate to use its amount, tax_, and tax_:
OptionalEstimate taxes with an IP addressServer-side
If you provide your customer’s IP address, we geolocate it and use that location as your customer’s location. Use this to show your customer a tax estimate before they provide their postal address.
Caution
Because the location of an IP address might be some distance from the actual customer location, we recommend against using an IP address to determine the final amount of tax to collect.
OptionalCollect customer tax IDsServer-side
In some cases, such as the cross-border supply of services, your customer might need to account for tax on a reverse charge basis. Instead of collecting the tax, you must issue an invoice with the text, “Tax to be paid on reverse charge basis.” This informs your customer that they’re responsible for any tax on their purchase.
Provide your customer’s tax IDs to automatically determine when reverse charge applies:
If you provide a tax ID with an invalid format, the calculation returns a tax_ error code:
{ "error": { "code": "tax_id_invalid", "doc_url": "https://docs.stripe.com/error-codes#tax-id-invalid", "message": "Invalid value for eu_vat.", "param": "customer_details[tax_ids][0][value]", "type": "invalid_request_error" } }
The Tax API doesn’t automatically validate tax IDs against government databases. To validate a tax ID before calculating tax, you must use customer tax ID validation.
OptionalTax-inclusive pricingServer-side
By default, tax is calculated on top of the line item and shipping cost amounts you provide. To calculate the tax included in your prices, set the tax_ to inclusive for the line item or shipping cost.
In the example below, the customer always pays 100 EUR:
The response returns the tax included:
{ ... "amount_total": 10000, ... "tax_amount_exclusive": 0, "tax_amount_inclusive": 1870, "tax_breakdown": [ { "amount": 1870, "inclusive": true, "tax_rate_details": { "country": "IE", "percentage_decimal": "23.0", "state": null, "tax_type": "vat" }, "taxability_reason": "standard_rated", "taxable_amount": 8130 } ], ... }
OptionalUse an existing Customer objectServer-side
If you provide a Customer object, we automatically copy and use the customer’s address and tax IDs for the calculation:
- If the customer
shippingis present, it’s copied tocustomer_.details. address - Otherwise, if the customer
addressis present, it’s copied tocustomer_.details. address - Otherwise, if the customer
tax.is present, it’s copied toip_ address customer_.details. ip_ address - Otherwise, if the customer
tax.is present, it’s copied totax_ exempt customer_.details. taxability_ override
The customer’s tax IDs are copied to customer_.
OptionalOverride customer taxabilityServer-side
You don’t need to collect tax in certain cases, such as when your customer is tax-exempt. You can provide the tax exemption to Stripe Tax using the taxability_override parameter.
To provide the customer taxability override to your calculations:
Reverse charge
Some regions, such as the European Union, implement a “reverse charge” scheme where the customer is responsible for accounting for tax if they’re purchasing as a business. For Stripe Tax to apply the correct tax treatment, we recommend you collect Tax IDs from your customers. Sometimes you might not have your customer’s tax IDs, or you’ve separately determined that the reverse charge scheme applies. In these types of scenarios, you can use taxability_ to force Stripe Tax to apply the reverse charge scheme.
To provide the customer taxability override to your calculations:
OptionalSpecify a ship-from locationServer-side
If you ship goods from a location other than your main place of business, you can provide that address for tax calculations.
To provide a ship-from location, use the ship_ parameter. In this example, the user is based in Florida, their customer is based in Springfield, IL, and the user is shipping the goods from Naperville, IL:
The response returns the calculated tax based on the shipping origin of the order (Naperville, IL) instead of the destination (Springfield, IL) or the seller’s business origin:
{ ... "amount_total": 1078, ... "tax_amount_exclusive": 78, ... "tax_breakdown": [ { "amount": 78, "inclusive": true, "tax_rate_details": { "country": "US", "percentage_decimal": "7.75", "state": "IL", "tax_type": "sales_tax" }, "taxability_reason": "standard_rated", "taxable_amount": 1000 } ], ... }
To learn more about how we calculate taxes in these scenarios, see the Stripe Tax documentation.
OptionalCalculate the retail delivery feeServer-side
Stripe Tax supports calculating the retail delivery fee in Minnesota and Colorado.
After you add a tax registration of the state_ type in the supported states, the retail delivery fee gets calculated on tax calculations.
To calculate the retail delivery fee, call the tax calculations API using a physical item product tax code, such as txcd_, which represents Clothing and Footwear.
Not all physical items trigger calculation of the retail delivery fee. Refer to the state’s documentation for when the tax applies:
The response returns the calculated tax with the retail delivery fee for Colorado. It’s an additional entry in the tax_ object, withtax_ set to flat_:
{ ... "amount_total": 2165, ... "tax_amount_exclusive": 165, ... "tax_breakdown": [ { "amount": 88, "inclusive": false, "tax_rate_details": { "percentage_decimal": "8.81", "rate_type": "percentage", "tax_type": "sales_tax", ... }, "taxability_reason": "standard_rated", "taxable_amount": 1000 }, ... { "amount": 29, "inclusive": false, "tax_rate_details": { "flat_amount": { "amount": 29, "currency": "usd" }, "percentage_decimal": "0.0", "rate_type": "flat_amount", "tax_type": "retail_delivery_fee", ... }, "taxability_reason": "standard_rated", "taxable_amount": 1000 } ], ... }
OptionalDetailed line item tax breakdownsServer-side
The top-level tax_breakdown is always returned and provides a simple breakdown that’s suitable for displaying a list of taxes at checkout or on a receipt.
You can use the taxability_reason to understand why tax isn’t applied while building your integration. For example, not_ doesn’t collect tax in the country or state where tax would be due. Adding tax registrations to your account settings tells Stripe where you’re collecting tax. If you added registration for Washington, the taxability reason displayed in your result is standard_, which indicates that the product is taxed at the standard rate.
Expand the line item tax_breakdown attribute to get a detailed breakdown, including local taxes and attributes that explain the reason for each tax.
- The
tax_field from tax_rate_details is a high-level tax type indication that might not always match the type returned in reports and transaction exports. For example, it doesn’t distinguish between US sales tax and US use tax.type - Use the
display_field from tax_rate_details in your Checkout flow to show all of the taxes. The taxes are localized based on customer location and product tax information. For example, if VAT is applied for Germany because the customer is in Germany and the product is taxed at the destination, such as txcd_10103001: Software as a service (SaaS) for business use, we showname Umsatzsteuer (USt), which is the German representation for VAT. If VAT is applied for France because the head office address is set to France and the product is taxed at the origin, such as txcd_20030000: General - Services, we showTaxe sur la valeur ajoutée (TVA), which is the French representation of VAT.
{ ... "tax_breakdown": [ { "amount": 103, "inclusive": false, "tax_rate_details": { "country": "US", "percentage_decimal": "10.25", "state": "WA", "tax_type": "sales_tax" }, "taxability_reason": "standard_rated", "taxable_amount": 1000 } ],
OptionalTroubleshoot common errorsServer-side
Follow the steps below to troubleshoot errors in your tax integration.
Resolve invalid tax code errors
If you receive an Invalid tax code error, refer to the Product tax codes for a list of available tax codes. Then, follow these steps to resolve the issue:
Check the tax code: Make sure you’re using a valid tax code from the list of available tax codes. Common mistakes include:
- Using an empty string or
nullas the tax code - Misspelling the tax code
- Using a non-existent tax code
- Using an empty string or
Update your code: Make sure you pass a valid tax code when creating a
TaxCalculation. For example:Use the default tax code: Stripe Tax uses a default tax code for calculations when a specific tax code isn’t provided for a product or in a tax calculation request. You can view and update the default value in your tax settings.
Use the API to update the default tax code:
Review your product catalog: If you use tax codes associated with products in your Stripe product catalog, make sure the tax codes are correctly assigned to your products.
Check for data inconsistencies: Make sure the tax code is correctly passed from your database or front end to your server-side code that makes the API call to Stripe.
For more accurate tax calculations, use the most specific tax code that applies to your product or service. If you’re unsure which tax code to use, consult the tax codes documentation.
If you continue to experience issues, review the Tax Settings API documentation.