Create a Tax Calculation

Tax

Tax Calculations

Calculates tax based on the input and returns a Tax Calculation object.

Parameters

currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.

line_itemsarray of objectsRequired
A list of items the customer is purchasing.
- line_items.amountintegerRequired
  A positive integer representing the line item’s total price in the smallest currency unit. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
- line_items.productstring
  If provided, the product’s tax_code will be used as the line item’s tax_code.
- line_items.quantityinteger
  The number of units of the item being purchased. Used to calculate the per-unit price from the total amount for the line. For example, if amount=100 and quantity=4, the calculated unit price is 25.
- line_items.referencestringRequired
  A custom identifier for this line item, which must be unique across the line items in the calculation. The reference helps identify each line item in exported tax reports.
- line_items.tax_behaviorenum
  Specifies whether the amount includes taxes. Defaults to exclusive.
  Possible enum values
  exclusive
  Taxes are calculated on top of the line item amount (default).
  inclusive
  Taxes are included in the line item amount.
- line_items.tax_codestring
  A tax code ID to use for this line item. If not provided, we will use the tax code from the provided product param. If neither tax_code nor product is provided, we will use the default tax code from your Tax Settings.

customer_detailsobjectRequired unless customer provided
Details about the customer, including address and tax IDs.
- customer_details.addressobjectRequired unless ip_address provided
  The customer’s postal address (for example, home or business location).
  customer_details.address.countrystringRequired
  Two-letter country code (ISO 3166-1 alpha-2).
  customer_details.address.citystring
  City, district, suburb, town, or village.
  customer_details.address.line1string
  Address line 1 (e.g., street, PO Box, or company name).
  customer_details.address.line2string
  Address line 2 (e.g., apartment, suite, unit, or building).
  customer_details.address.postal_codestringRequired for us addresses
  ZIP or postal code.
  customer_details.address.statestring
  State, county, province, or region. We recommend sending ISO 3166-2 subdivision code value when possible.
- customer_details.address_sourceenumRequired when using address
  The type of customer address provided.
  Possible enum values
  billing
  Denotes the address as billing address.
  shipping
  Denotes the address as shipping address.
- customer_details.ip_addressstringRequired unless address provided
  The customer’s IP address (IPv4 or IPv6).
- customer_details.tax_idsarray of objects
  The customer’s tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn’t validate tax IDs for correctness.
  customer_details.tax_ids.typestringRequired
  Type of the tax ID, one of ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, br_cpf, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, ch_uid, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, eu_vat, gb_vat, ge_vat, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kr_brn, kz_bin, li_uid, ma_vat, md_vat, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, tz_vat, ua_vat, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, or za_vat
  customer_details.tax_ids.valuestringRequired
  Value of the tax ID.
- customer_details.taxability_overrideenum
  Overrides the tax calculation result to allow you to not collect tax from your customer. Use this if you’ve manually checked your customer’s tax exemptions. Prefer providing the customer’s tax_ids where possible, which automatically determines whether reverse_charge applies.
  Possible enum values
  customer_exempt
  The customer is exempt of tax.
  none
  No taxability override (default).
  reverse_charge
  The customer is entitled to reverse charge tax treatment.

shipping_costobject
Shipping cost details to be used for the calculation.
- shipping_cost.amountintegerRequired unless shipping_rate provided
  A positive integer in the smallest currency unit representing the shipping charge. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.
- shipping_cost.shipping_ratestringRequired unless amount provided
  If provided, the shipping rate’s amount, tax_code and tax_behavior are used. If you provide a shipping rate, then you cannot pass the amount, tax_code, or tax_behavior parameters.
- shipping_cost.tax_behaviorenum
  Specifies whether the amount includes taxes. If tax_behavior=inclusive, then the amount includes taxes. Defaults to exclusive.
  Possible enum values
  exclusive
  Taxes are calculated on top of the line item amount (default).
  inclusive
  Taxes are included in the line item amount.
- shipping_cost.tax_codestring
  The tax code used to calculate tax on shipping. If not provided, the default shipping tax code from your Tax Settings is used.

More parameters

customerstringRequired unless customer_details provided
The ID of an existing customer to use for this calculation. If provided, the customer’s address and tax IDs are copied to customer_details.

ship_from_detailsobject
Details about the address from which the goods are being shipped.
- ship_from_details.addressobjectRequired
  The address from which the goods are being shipped from.
  ship_from_details.address.countrystringRequired
  Two-letter country code (ISO 3166-1 alpha-2).
  ship_from_details.address.citystring
  City, district, suburb, town, or village.
  ship_from_details.address.line1string
  Address line 1 (e.g., street, PO Box, or company name).
  ship_from_details.address.line2string
  Address line 2 (e.g., apartment, suite, unit, or building).
  ship_from_details.address.postal_codestringRequired for us addresses
  ZIP or postal code.
  ship_from_details.address.statestring
  State/province as an ISO 3166-2 subdivision code, without country prefix. Example: “NY” or “TX”.

tax_dateinteger
Timestamp of date at which the tax rules and rates in effect applies for the calculation. Measured in seconds since the Unix epoch. Can be up to 48 hours in the past, and up to 48 hours in the future.

Returns

A Tax Calculation object containing the first 100 input line_items if the calculation succeeds. Otherwise, an error (for example, indicating that the customer address was invalid).

POST /v1/tax/calculations

Server-side language

curl https://api.stripe.com/v1/tax/calculations \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d currency=usd \
  -d "customer_details[address][line1]"="920 5th Ave" \
  -d "customer_details[address][city]"=Seattle \
  -d "customer_details[address][state]"=WA \
  -d "customer_details[address][postal_code]"=98104 \
  -d "customer_details[address][country]"=US \
  -d "customer_details[address_source]"=shipping \
  -d "line_items[0][amount]"=1499 \
  -d "line_items[0][tax_code]"=txcd_10000000 \
  -d "line_items[0][reference]"="Music Streaming Coupon" \
  -d "shipping_cost[amount]"=300 \
  -d "expand[0]"=line_items

Response

{
  "id": "taxcalc_1OduxkBUZ691iUZ4iWvpMApI",
  "object": "tax.calculation",
  "amount_total": 1953,
  "currency": "usd",
  "customer": null,
  "customer_details": {
    "address": {
      "city": "Seattle",
      "country": "US",
      "line1": "920 5th Ave",
      "line2": null,
      "postal_code": "98104",
      "state": "WA"
    },
    "address_source": "shipping",
    "ip_address": null,
    "tax_ids": [],
    "taxability_override": "none"
  },
  "expires_at": 1706708005,
  "line_items": {
    "object": "list",
    "data": [
      {
        "id": "tax_li_PSqf3RMNZa23H4",
        "object": "tax.calculation_line_item",
        "amount": 1499,
        "amount_tax": 154,
        "livemode": false,
        "product": null,
        "quantity": 1,
        "reference": "Music Streaming Coupon",
        "tax_behavior": "exclusive",
        "tax_code": "txcd_10000000"
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/v1/tax/calculations/taxcalc_1OduxkBUZ691iUZ4iWvpMApI/line_items"
  },
  "livemode": false,
  "ship_from_details": null,
  "shipping_cost": {
    "amount": 300,
    "amount_tax": 0,
    "tax_behavior": "exclusive",
    "tax_code": "txcd_92010001"
  },
  "tax_amount_exclusive": 154,
  "tax_amount_inclusive": 0,
  "tax_breakdown": [
    {
      "amount": 154,
      "inclusive": false,
      "tax_rate_details": {
        "country": "US",
        "percentage_decimal": "10.25",
        "state": "WA",
        "tax_type": "sales_tax"
      },
      "taxability_reason": "standard_rated",
      "taxable_amount": 1499
    },
    {
      "amount": 0,
      "inclusive": false,
      "tax_rate_details": {
        "country": "DE",
        "percentage_decimal": "0.0",
        "state": null,
        "tax_type": "vat"
      },
      "taxability_reason": "zero_rated",
      "taxable_amount": 300
    }
  ],
  "tax_date": 1706535204
}

Create a Tax Calculation

Parameters

currencyenumRequired

line_itemsarray of objectsRequired

line_items.amountintegerRequired

line_items.productstring

line_items.quantityinteger

line_items.referencestringRequired

line_items.tax_behaviorenum

line_items.tax_codestring

customer_detailsobjectRequired unless customer provided

customer_details.addressobjectRequired unless ip_address provided

customer_details.address.countrystringRequired

customer_details.address.citystring

customer_details.address.line1string

customer_details.address.line2string

customer_details.address.postal_codestringRequired for us addresses

customer_details.address.statestring

customer_details.address_sourceenumRequired when using address

customer_details.ip_addressstringRequired unless address provided

customer_details.tax_idsarray of objects

customer_details.tax_ids.typestringRequired

customer_details.tax_ids.valuestringRequired

customer_details.taxability_overrideenum

shipping_costobject

shipping_cost.amountintegerRequired unless shipping_rate provided

shipping_cost.shipping_ratestringRequired unless amount provided

shipping_cost.tax_behaviorenum

shipping_cost.tax_codestring

More parametersCollapse all

customerstringRequired unless customer_details provided

ship_from_detailsobject

ship_from_details.addressobjectRequired

ship_from_details.address.countrystringRequired

ship_from_details.address.citystring

ship_from_details.address.line1string

ship_from_details.address.line2string

ship_from_details.address.postal_codestringRequired for us addresses

ship_from_details.address.statestring

tax_dateinteger

Returns

More parameters