Stripe: Tax schemas

← Tax operations · All schemas

Create a Calculation — request body — body customer details address

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	Maximum length: 5000
city (anyOf 2)	string	Alternative	One of:
country	string	Required within parent	Maximum length: 5000
line1	JSON	Optional
line1 (anyOf 1)	string	Alternative	Maximum length: 5000
line1 (anyOf 2)	string	Alternative	One of:
line2	JSON	Optional
line2 (anyOf 1)	string	Alternative	Maximum length: 5000
line2 (anyOf 2)	string	Alternative	One of:
postal_code	JSON	Optional
postal_code (anyOf 1)	string	Alternative	Maximum length: 5000
postal_code (anyOf 2)	string	Alternative	One of:
state	JSON	Optional
state (anyOf 1)	string	Alternative	Maximum length: 5000
state (anyOf 2)	string	Alternative	One of:

Create a Calculation — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Tax Calculation allows you to calculate the tax to collect from your customer. Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)
amount_total	JSON	Required within parent
amount_total (anyOf 1)	integer	Alternative	Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount_total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Maximum length: 5000
customer	JSON	Optional
customer (anyOf 1)	string	Alternative	The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource. Maximum length: 5000
customer (anyOf 2)	null	Alternative
customer_details	Model	Required within parent	Expand Create a Calculation — response body — customer details
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	Timestamp of date at which the tax calculation will expire. Format: unix-time
expires_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	Unique identifier for the calculation. Maximum length: 5000
id (anyOf 2)	null	Alternative
line_items	JSON	Optional
line_items (anyOf 1)	object	Alternative	The list of items the customer is purchasing.
line_items (anyOf 1).data	array	Required within parent	Details about each object.
line_items (anyOf 1).data[]	Model	Each item	Expand Retrieve a Calculation's line items — response body — data item
line_items (anyOf 1).has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
line_items (anyOf 1).object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
line_items (anyOf 1).url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/tax/calculations/[^/]+/line_items
line_items (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.calculation
ship_from_details	JSON	Optional
ship_from_details (anyOf 1)	JSON	Alternative	The details of the ship from location, such as the address.
ship_from_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Calculation — response body — ship from details value address
ship_from_details (anyOf 2)	null	Alternative
shipping_cost	JSON	Optional
shipping_cost (anyOf 1)	JSON	Alternative	The shipping cost details for the calculation.
shipping_cost (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Calculation — response body — shipping_cost / The shipping cost details for the calculation / tax_behavior: exclusive, inclusive
shipping_cost (anyOf 2)	null	Alternative
tax_amount_exclusive	JSON	Required within parent
tax_amount_exclusive (anyOf 1)	integer	Alternative	The amount of tax to be collected on top of the line item prices.
tax_amount_exclusive (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_amount_inclusive	JSON	Required within parent
tax_amount_inclusive (anyOf 1)	integer	Alternative	The amount of tax already included in the line item prices.
tax_amount_inclusive (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_breakdown	array	Required within parent	Breakdown of individual tax amounts that add up to the total.
tax_breakdown[]	Model	Each item	Expand Create a Calculation — response body — tax breakdown item
tax_date	JSON	Required within parent
tax_date (anyOf 1)	integer	Alternative	The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window. Format: unix-time
tax_date (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a Calculation's line items — response body — data item, Create a Calculation — response body — customer details, Create a Calculation — response body — ship from details value address, Create a Calculation — response body — tax breakdown item, Create a Calculation — response body — shipping_cost / The shipping cost details for the calculation / tax_behavior: exclusive, inclusive

Create a Calculation — response body — customer details

Field	Type	Presence	Description and constraints
$	object	Root
address	JSON	Optional
address (anyOf 1)	JSON	Alternative	The customer's postal address (for example, home or business location).
address (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Calculation — response body — ship from details value address address
address (anyOf 2)	null	Alternative
address_source	JSON	Optional
address_source (anyOf 1)	string	Alternative	The type of customer address provided. Known values: billing, shipping
address_source (anyOf 2)	null	Alternative
ip_address	JSON	Optional
ip_address (anyOf 1)	string	Alternative	The customer's IP address (IPv4 or IPv6). Maximum length: 5000
ip_address (anyOf 2)	null	Alternative
tax_ids	array	Required within parent	The customer's tax IDs (for example, EU VAT numbers).
tax_ids[]	Model	Each item	Expand Create a Calculation — response body — customer details tax ids item
taxability_override	string	Required within parent	The taxability override used for taxation. Known values: customer_exempt, none, reverse_charge

Referenced models: Create a Calculation — response body — customer details tax ids item, Create a Calculation — response body — ship from details value address address

Create a Calculation — response body — customer details tax ids item

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, `ic_nif`, or `unknown` Known values: ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, fo_vat, gb_vat, ge_vat, gi_tin, gn_nif, hk_br, hr_oib, hu_tin, ic_nif, id_npwp, il_vat, in_gst, is_vat, it_cf, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, lk_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, pl_nip, py_ruc, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, unknown, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, zw_tin
value	string	Required within parent	The value of the tax ID. Maximum length: 5000

Create a Calculation — response body — ship from details value address

Field	Type	Presence	Description and constraints
$	object	Root
address	Model	Required within parent	Expand Create a Calculation — response body — ship from details value address address

Referenced models: Create a Calculation — response body — ship from details value address address

Create a Calculation — response body — ship from details value address address

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	City, district, suburb, town, or village. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	string	Required within parent	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
line1	JSON	Optional
line1 (anyOf 1)	string	Alternative	Address line 1, such as the street, PO Box, or company name. Maximum length: 5000
line1 (anyOf 2)	null	Alternative
line2	JSON	Optional
line2 (anyOf 1)	string	Alternative	Address line 2, such as the apartment, suite, unit, or building. Maximum length: 5000
line2 (anyOf 2)	null	Alternative
postal_code	JSON	Optional
postal_code (anyOf 1)	string	Alternative	ZIP or postal code. Maximum length: 5000
postal_code (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX". Maximum length: 5000
state (anyOf 2)	null	Alternative

Create a Calculation — response body — shipping_cost / The shipping cost details for the calculation / tax_behavior: exclusive, inclusive

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_tax	JSON	Required within parent
amount_tax (anyOf 1)	integer	Alternative	The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount_tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shipping_rate	string	Optional	The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). Maximum length: 5000
tax_behavior	string	Required within parent	Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Known values: exclusive, inclusive
tax_breakdown	array	Optional	Detailed account of taxes relevant to shipping cost.
tax_breakdown[]	Model	Each item	Expand Retrieve a Calculation's line items — response body — data item tax breakdown array item
tax_code	string	Required within parent	The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. Maximum length: 5000

Referenced models: Retrieve a Calculation's line items — response body — data item tax breakdown array item

Create a Calculation — response body — tax breakdown item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inclusive	boolean	Required within parent	Specifies whether the tax amount is included in the line item amount.
tax_rate_details	Model	Required within parent	Expand Create a Calculation — response body — tax breakdown item tax rate details
taxability_reason	string	Required within parent	The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules. Known values: customer_exempt, not_collecting, not_subject_to_tax, not_supported, portion_product_exempt, portion_reduced_rated, portion_standard_rated, product_exempt, product_exempt_holiday, proportionally_rated, reduced_rated, reverse_charge, standard_rated, taxable_basis_reduced, zero_rated
taxable_amount	JSON	Required within parent
taxable_amount (anyOf 1)	integer	Alternative	The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
taxable_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create a Calculation — response body — tax breakdown item tax rate details

Create a Calculation — response body — tax breakdown item tax rate details

Field	Type	Presence	Description and constraints
$	object	Root
country	JSON	Optional
country (anyOf 1)	string	Alternative	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
country (anyOf 2)	null	Alternative
flat_amount	JSON	Optional
flat_amount (anyOf 1)	JSON	Alternative	The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.
flat_amount (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a tax rate — response body — flat amount value amount, currency
flat_amount (anyOf 2)	null	Alternative
percentage_decimal	string	Required within parent	The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`. Maximum length: 5000
rate_type	JSON	Optional
rate_type (anyOf 1)	string	Alternative	Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Known values: flat_amount, percentage
rate_type (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000
state (anyOf 2)	null	Alternative
tax_type	JSON	Optional
tax_type (anyOf 1)	string	Alternative	The tax type, such as `vat` or `sales_tax`. Known values: admissions_tax, amusement_tax, attendance_tax, communications_tax, digital_excise_tax, entertainment_tax, gross_receipts_tax, gst, hospitality_tax, hst, igst, jct, lease_tax, luxury_tax, mass_transit_parking_tax, parking_tax, pst, qst, recycling_fee, resort_tax, retail_delivery_fee, rst, sales_tax, service_tax, tourism_tax, utility_users_tax, vat
tax_type (anyOf 2)	null	Alternative

Referenced models: Create a tax rate — response body — flat amount value amount, currency

Create a registration — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax). Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering). Related guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api)
active_from	JSON	Required within parent
active_from (anyOf 1)	integer	Alternative	Time at which the registration becomes active. Measured in seconds since the Unix epoch. Format: unix-time
active_from (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
country	string	Required within parent	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
country_options	Model	Required within parent	Expand Create a registration — response body — country options
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch. Format: unix-time
expires_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.registration
status	string	Required within parent	The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`. Known values: active, expired, scheduled

Referenced models: Create a registration — response body — country options

Create a registration — response body — country options

Field	Type	Presence	Description and constraints
$	object	Root
ae	Model	Optional	Expand Create a registration — response body — country options ae
al	Model	Optional	Expand Create a registration — response body — country options al
am	Model	Optional	Expand Create a registration — response body — country options am
ao	Model	Optional	Expand Create a registration — response body — country options al
at	Model	Optional	Expand Create a registration — response body — country options at
au	Model	Optional	Expand Create a registration — response body — country options ae
aw	Model	Optional	Expand Create a registration — response body — country options al
az	Model	Optional	Expand Create a registration — response body — country options am
ba	Model	Optional	Expand Create a registration — response body — country options al
bb	Model	Optional	Expand Create a registration — response body — country options al
bd	Model	Optional	Expand Create a registration — response body — country options al
be	Model	Optional	Expand Create a registration — response body — country options at
bf	Model	Optional	Expand Create a registration — response body — country options al
bg	Model	Optional	Expand Create a registration — response body — country options at
bh	Model	Optional	Expand Create a registration — response body — country options al
bj	Model	Optional	Expand Create a registration — response body — country options am
bs	Model	Optional	Expand Create a registration — response body — country options al
by	Model	Optional	Expand Create a registration — response body — country options am
ca	Model	Optional	Expand Create a registration — response body — country options ca
cd	Model	Optional	Expand Create a registration — response body — country options al
ch	Model	Optional	Expand Create a registration — response body — country options ae
cl	Model	Optional	Expand Create a registration — response body — country options am
cm	Model	Optional	Expand Create a registration — response body — country options am
co	Model	Optional	Expand Create a registration — response body — country options am
cr	Model	Optional	Expand Create a registration — response body — country options am
cv	Model	Optional	Expand Create a registration — response body — country options am
cy	Model	Optional	Expand Create a registration — response body — country options at
cz	Model	Optional	Expand Create a registration — response body — country options at
de	Model	Optional	Expand Create a registration — response body — country options at
dk	Model	Optional	Expand Create a registration — response body — country options at
ec	Model	Optional	Expand Create a registration — response body — country options am
ee	Model	Optional	Expand Create a registration — response body — country options at
eg	Model	Optional	Expand Create a registration — response body — country options am
es	Model	Optional	Expand Create a registration — response body — country options es
et	Model	Optional	Expand Create a registration — response body — country options al
fi	Model	Optional	Expand Create a registration — response body — country options at
fr	Model	Optional	Expand Create a registration — response body — country options at
gb	Model	Optional	Expand Create a registration — response body — country options ae
ge	Model	Optional	Expand Create a registration — response body — country options am
gn	Model	Optional	Expand Create a registration — response body — country options al
gr	Model	Optional	Expand Create a registration — response body — country options at
hr	Model	Optional	Expand Create a registration — response body — country options at
hu	Model	Optional	Expand Create a registration — response body — country options at
id	Model	Optional	Expand Create a registration — response body — country options am
ie	Model	Optional	Expand Create a registration — response body — country options at
in	Model	Optional	Expand Create a registration — response body — country options am
is	Model	Optional	Expand Create a registration — response body — country options al
it	Model	Optional	Expand Create a registration — response body — country options at
jp	Model	Optional	Expand Create a registration — response body — country options ae
ke	Model	Optional	Expand Create a registration — response body — country options am
kg	Model	Optional	Expand Create a registration — response body — country options am
kh	Model	Optional	Expand Create a registration — response body — country options am
kr	Model	Optional	Expand Create a registration — response body — country options am
kz	Model	Optional	Expand Create a registration — response body — country options am
la	Model	Optional	Expand Create a registration — response body — country options am
lk	Model	Optional	Expand Create a registration — response body — country options am
lt	Model	Optional	Expand Create a registration — response body — country options at
lu	Model	Optional	Expand Create a registration — response body — country options at
lv	Model	Optional	Expand Create a registration — response body — country options at
ma	Model	Optional	Expand Create a registration — response body — country options am
md	Model	Optional	Expand Create a registration — response body — country options am
me	Model	Optional	Expand Create a registration — response body — country options al
mk	Model	Optional	Expand Create a registration — response body — country options al
mr	Model	Optional	Expand Create a registration — response body — country options al
mt	Model	Optional	Expand Create a registration — response body — country options at
mx	Model	Optional	Expand Create a registration — response body — country options am
my	Model	Optional	Expand Create a registration — response body — country options am
ng	Model	Optional	Expand Create a registration — response body — country options am
nl	Model	Optional	Expand Create a registration — response body — country options at
no	Model	Optional	Expand Create a registration — response body — country options ae
np	Model	Optional	Expand Create a registration — response body — country options am
nz	Model	Optional	Expand Create a registration — response body — country options ae
om	Model	Optional	Expand Create a registration — response body — country options al
pe	Model	Optional	Expand Create a registration — response body — country options am
ph	Model	Optional	Expand Create a registration — response body — country options am
pl	Model	Optional	Expand Create a registration — response body — country options at
pt	Model	Optional	Expand Create a registration — response body — country options at
ro	Model	Optional	Expand Create a registration — response body — country options at
rs	Model	Optional	Expand Create a registration — response body — country options al
ru	Model	Optional	Expand Create a registration — response body — country options am
sa	Model	Optional	Expand Create a registration — response body — country options am
se	Model	Optional	Expand Create a registration — response body — country options at
sg	Model	Optional	Expand Create a registration — response body — country options ae
si	Model	Optional	Expand Create a registration — response body — country options at
sk	Model	Optional	Expand Create a registration — response body — country options at
sn	Model	Optional	Expand Create a registration — response body — country options am
sr	Model	Optional	Expand Create a registration — response body — country options al
th	Model	Optional	Expand Create a registration — response body — country options am
tj	Model	Optional	Expand Create a registration — response body — country options am
tr	Model	Optional	Expand Create a registration — response body — country options am
tw	Model	Optional	Expand Create a registration — response body — country options am
tz	Model	Optional	Expand Create a registration — response body — country options am
ua	Model	Optional	Expand Create a registration — response body — country options am
ug	Model	Optional	Expand Create a registration — response body — country options am
us	Model	Optional	Expand Create a registration — response body — country options us
uy	Model	Optional	Expand Create a registration — response body — country options al
uz	Model	Optional	Expand Create a registration — response body — country options am
vn	Model	Optional	Expand Create a registration — response body — country options am
za	Model	Optional	Expand Create a registration — response body — country options al
zm	Model	Optional	Expand Create a registration — response body — country options am
zw	Model	Optional	Expand Create a registration — response body — country options al

Referenced models: Create a registration — response body — country options ca, Create a registration — response body — country options al, Create a registration — response body — country options ae, Create a registration — response body — country options at, Create a registration — response body — country options am, Create a registration — response body — country options es, Create a registration — response body — country options us

Create a registration — response body — country options ae

Field	Type	Presence	Description and constraints
$	object	Root
standard	Model	Optional	Expand Create a registration — response body — country options ae standard
type	string	Required within parent	Type of registration in `country`. Known values: standard

Referenced models: Create a registration — response body — country options ae standard

Create a registration — response body — country options ae standard

Field	Type	Presence	Description and constraints
$	object	Root
place_of_supply_scheme	string	Required within parent	Place of supply scheme used in an Default standard registration. Known values: inbound_goods, standard

Create a registration — response body — country options al

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Type of registration in `country`. Known values: standard

Create a registration — response body — country options am

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Type of registration in `country`. Known values: simplified

Create a registration — response body — country options at

Field	Type	Presence	Description and constraints
$	object	Root
standard	Model	Optional	Expand Create a registration — response body — country options at standard
type	string	Required within parent	Type of registration in an EU country. Known values: ioss, oss_non_union, oss_union, standard

Referenced models: Create a registration — response body — country options at standard

Create a registration — response body — country options at standard

Field	Type	Presence	Description and constraints
$	object	Root
place_of_supply_scheme	string	Required within parent	Place of supply scheme used in an EU standard registration. Known values: inbound_goods, small_seller, standard

Create a registration — response body — country options ca

Field	Type	Presence	Description and constraints
$	object	Root
province_standard	Model	Optional	Expand Create a registration — response body — country options ca province standard
type	string	Required within parent	Type of registration in Canada. Known values: province_standard, simplified, standard

Referenced models: Create a registration — response body — country options ca province standard

Create a registration — response body — country options ca province standard

Field	Type	Presence	Description and constraints
$	object	Root
province	string	Required within parent	Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000

Create a registration — response body — country options es

Field	Type	Presence	Description and constraints
$	object	Root
standard	Model	Optional	Expand Create a registration — response body — country options at standard
type	string	Required within parent	Type of registration in ES. Known values: ioss, oss_non_union, oss_union, standard

Referenced models: Create a registration — response body — country options at standard

Create a registration — response body — country options us

Field	Type	Presence	Description and constraints
$	object	Root
admissions_tax	Model	Optional	Expand Create a registration — response body — country options us admissions tax
attendance_tax	Model	Optional	Expand Create a registration — response body — country options us attendance tax
entertainment_tax	Model	Optional	Expand Create a registration — response body — country options us entertainment tax
gross_receipts_tax	Model	Optional	Expand Create a registration — response body — country options us gross receipts tax
hospitality_tax	Model	Optional	Expand Create a registration — response body — country options us hospitality tax
local_amusement_tax	Model	Optional	Expand Create a registration — response body — country options us local lease tax
local_lease_tax	Model	Optional	Expand Create a registration — response body — country options us local lease tax
luxury_tax	Model	Optional	Expand Create a registration — response body — country options us luxury tax
mass_transit_parking_tax	Model	Optional	Expand Create a registration — response body — country options us mass transit parking tax
parking_tax	Model	Optional	Expand Create a registration — response body — country options us parking tax
resort_tax	Model	Optional	Expand Create a registration — response body — country options us resort tax
state	string	Required within parent	Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000
state_sales_tax	Model	Optional	Expand Create a registration — response body — country options us state sales tax
tourism_tax	Model	Optional	Expand Create a registration — response body — country options us tourism tax
type	string	Required within parent	Type of registration in the US. Known values: admissions_tax, attendance_tax, entertainment_tax, gross_receipts_tax, hospitality_tax, local_amusement_tax, local_lease_tax, luxury_tax, mass_transit_parking_tax, parking_tax, resort_tax, state_communications_tax, state_retail_delivery_fee, state_sales_tax, tourism_tax

Referenced models: Create a registration — response body — country options us admissions tax, Create a registration — response body — country options us attendance tax, Create a registration — response body — country options us entertainment tax, Create a registration — response body — country options us gross receipts tax, Create a registration — response body — country options us hospitality tax, Create a registration — response body — country options us local lease tax, Create a registration — response body — country options us luxury tax, Create a registration — response body — country options us mass transit parking tax, Create a registration — response body — country options us parking tax, Create a registration — response body — country options us resort tax, Create a registration — response body — country options us state sales tax, Create a registration — response body — country options us tourism tax

Create a registration — response body — country options us admissions tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=admissions_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us attendance tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=attendance_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us entertainment tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=entertainment_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us gross receipts tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=gross_receipts_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us hospitality tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=hospitality_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us local lease tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us luxury tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=luxury_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us mass transit parking tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=mass_transit_parking_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us parking tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=parking_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us resort tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=resort_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a registration — response body — country options us state sales tax

Field	Type	Presence	Description and constraints
$	object	Root
elections	array	Optional	Elections for the state sales tax registration.
elections[]	Model	Each item	Expand Create a registration — response body — country options us state sales tax elections item

Referenced models: Create a registration — response body — country options us state sales tax elections item

Create a registration — response body — country options us state sales tax elections item

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Optional	A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Maximum length: 5000
type	string	Required within parent	The type of the election for the state sales tax registration. Known values: local_use_tax, simplified_sellers_use_tax, single_local_use_tax

Create a registration — response body — country options us tourism tax

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=tourism_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Create a reversal Transaction — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Tax Transaction records the tax collected from or refunded to your customer. Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom#tax-transaction)
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Maximum length: 5000
customer	JSON	Optional
customer (anyOf 1)	string	Alternative	The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource. Maximum length: 5000
customer (anyOf 2)	null	Alternative
customer_details	Model	Required within parent	Expand Create a Calculation — response body — customer details
id	string	Required within parent	Unique identifier for the transaction. Maximum length: 5000
line_items	JSON	Optional
line_items (anyOf 1)	object	Alternative	The tax collected or refunded, by line item.
line_items (anyOf 1).data	array	Required within parent	Details about each object.
line_items (anyOf 1).data[]	Model	Each item	Expand Retrieve a Transaction's line items — response body — data item
line_items (anyOf 1).has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
line_items (anyOf 1).object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
line_items (anyOf 1).url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/tax/transactions/[^/]+/line_items
line_items (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.transaction
posted_at	JSON	Required within parent
posted_at (anyOf 1)	integer	Alternative	The Unix timestamp representing when the tax liability is assumed or reduced. Format: unix-time
posted_at (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reference	string	Required within parent	A custom unique identifier, such as 'myOrder_123'. Maximum length: 5000
reversal	JSON	Optional
reversal (anyOf 1)	JSON	Alternative	If `type=reversal`, contains information about what was reversed.
reversal (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a reversal Transaction — response body — reversal value original transaction
reversal (anyOf 2)	null	Alternative
ship_from_details	JSON	Optional
ship_from_details (anyOf 1)	JSON	Alternative	The details of the ship from location, such as the address.
ship_from_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Calculation — response body — ship from details value address
ship_from_details (anyOf 2)	null	Alternative
shipping_cost	JSON	Optional
shipping_cost (anyOf 1)	JSON	Alternative	The shipping cost details for the transaction.
shipping_cost (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a reversal Transaction — response body — shipping_cost / The shipping cost details for the transaction / tax_behavior: exclusive, inclusive
shipping_cost (anyOf 2)	null	Alternative
tax_date	JSON	Required within parent
tax_date (anyOf 1)	integer	Alternative	The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window. Format: unix-time
tax_date (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	If `reversal`, this transaction reverses an earlier transaction. Known values: reversal, transaction

Referenced models: Retrieve a Transaction's line items — response body — data item, Create a Calculation — response body — customer details, Create a Calculation — response body — ship from details value address, Create a reversal Transaction — response body — reversal value original transaction, Create a reversal Transaction — response body — shipping_cost / The shipping cost details for the transaction / tax_behavior: exclusive, inclusive

Create a reversal Transaction — response body — reversal value original transaction

Field	Type	Presence	Description and constraints
$	object	Root
original_transaction	JSON	Optional
original_transaction (anyOf 1)	string	Alternative	The `id` of the reversed `Transaction` object. Maximum length: 5000
original_transaction (anyOf 2)	null	Alternative

Create a reversal Transaction — response body — shipping_cost / The shipping cost details for the transaction / tax_behavior: exclusive, inclusive

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_tax	JSON	Required within parent
amount_tax (anyOf 1)	integer	Alternative	The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount_tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shipping_rate	string	Optional	The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). Maximum length: 5000
tax_behavior	string	Required within parent	Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Known values: exclusive, inclusive
tax_code	string	Required within parent	The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. Maximum length: 5000

Create a tax location — response body

Field	Type	Presence	Description and constraints
$	object	Root	Tax locations represent venues for services, tickets, or other product types.
address	Model	Required within parent	Expand Create a Location — response body — address
description	JSON	Optional
description (anyOf 1)	string	Alternative	A descriptive text providing additional context about the tax location. This can include information about the venue, types of events held, services available, or any relevant details for better identification (for example, "A spacious auditorium suitable for large concerts and events."). Maximum length: 5000
description (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.location
type	string	Required within parent	The type of tax location to be defined. Currently the only option is `performance`. Known values: performance

Referenced models: Create a Location — response body — address

Find a Tax Association — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
calculation	string	Required within parent	The [Tax Calculation](https://docs.stripe.com/api/tax/calculations/object) that was included in PaymentIntent. Maximum length: 5000
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.association
payment_intent	string	Required within parent	The [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) that this Tax Association is tracking. Maximum length: 5000
tax_transaction_attempts	JSON	Optional
tax_transaction_attempts (anyOf 1)	array	Alternative	Information about the tax transactions linked to this payment intent
tax_transaction_attempts (anyOf 1)[]	Model	Each item	Expand Find a Tax Association — response body — tax transaction attempts array item
tax_transaction_attempts (anyOf 2)	null	Alternative

Referenced models: Find a Tax Association — response body — tax transaction attempts array item

Find a Tax Association — response body — tax transaction attempts array item

Field	Type	Presence	Description and constraints
$	object	Root
committed	Model	Optional	Expand Find a Tax Association — response body — tax transaction attempts array item committed
errored	Model	Optional	Expand Find a Tax Association — response body — tax transaction attempts array item errored
source	string	Required within parent	The source of the tax transaction attempt. This is either a refund or a payment intent. Maximum length: 5000
status	string	Required within parent	The status of the transaction attempt. This can be `errored` or `committed`. Maximum length: 5000

Referenced models: Find a Tax Association — response body — tax transaction attempts array item committed, Find a Tax Association — response body — tax transaction attempts array item errored

Find a Tax Association — response body — tax transaction attempts array item committed

Field	Type	Presence	Description and constraints
$	object	Root
transaction	string	Required within parent	The [Tax Transaction](https://docs.stripe.com/api/tax/transaction/object) Maximum length: 5000

Find a Tax Association — response body — tax transaction attempts array item errored

Field	Type	Presence	Description and constraints
$	object	Root
reason	string	Required within parent	Details on why we couldn't commit the tax transaction. Known values: another_payment_associated_with_calculation, calculation_expired, currency_mismatch, original_transaction_voided, unique_reference_violation

Retrieve a Calculation's line items — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	A Tax Calculation Line Item represents a single item in a tax calculation.
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_tax	JSON	Required within parent
amount_tax (anyOf 1)	integer	Alternative	The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount_tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.calculation_line_item
performance_location	JSON	Optional
performance_location (anyOf 1)	string	Alternative	Indicates the line item represents a performance where the venue location might determine the tax, not the customer address. Leave empty if the tax code doesn't require a tax location. If you provide this value for tax codes with an `optional` location requirement, it overrides the customer address. Maximum length: 5000
performance_location (anyOf 2)	null	Alternative
product	JSON	Optional
product (anyOf 1)	string	Alternative	The ID of an existing [Product](https://docs.stripe.com/api/products/object). Maximum length: 5000
product (anyOf 2)	null	Alternative
quantity	JSON	Required within parent
quantity (anyOf 1)	integer	Alternative	The number of units of the item being purchased. For reversals, this is the quantity reversed.
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reference	string	Required within parent	A custom identifier for this line item. Maximum length: 5000
tax_behavior	string	Required within parent	Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Known values: exclusive, inclusive
tax_breakdown	JSON	Optional
tax_breakdown (anyOf 1)	array	Alternative	Detailed account of taxes relevant to this line item.
tax_breakdown (anyOf 1)[]	Model	Each item	Expand Retrieve a Calculation's line items — response body — data item tax breakdown array item
tax_breakdown (anyOf 2)	null	Alternative
tax_code	string	Required within parent	The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. Maximum length: 5000

Referenced models: Retrieve a Calculation's line items — response body — data item tax breakdown array item

Retrieve a Calculation's line items — response body — data item tax breakdown array item

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jurisdiction	Model	Required within parent	Expand Retrieve a Calculation's line items — response body — data item tax breakdown array item jurisdiction
sourcing	string	Required within parent	Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address). Known values: destination, origin, performance
tax_rate_details	JSON	Optional
tax_rate_details (anyOf 1)	JSON	Alternative	Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
tax_rate_details (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Calculation's line items — response body — data item tax breakdown array item tax rate details value display name, percentage decimal, tax type
tax_rate_details (anyOf 2)	null	Alternative
taxability_reason	string	Required within parent	The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Known values: customer_exempt, not_collecting, not_subject_to_tax, not_supported, portion_product_exempt, portion_reduced_rated, portion_standard_rated, product_exempt, product_exempt_holiday, proportionally_rated, reduced_rated, reverse_charge, standard_rated, taxable_basis_reduced, zero_rated
taxable_amount	JSON	Required within parent
taxable_amount (anyOf 1)	integer	Alternative	The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
taxable_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a Calculation's line items — response body — data item tax breakdown array item jurisdiction, Retrieve a Calculation's line items — response body — data item tax breakdown array item tax rate details value display name, percentage decimal, tax type

Retrieve a Calculation's line items — response body — data item tax breakdown array item jurisdiction

Field	Type	Presence	Description and constraints
$	object	Root
country	string	Required within parent	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
display_name	string	Required within parent	A human-readable name for the jurisdiction imposing the tax. Maximum length: 5000
level	string	Required within parent	Indicates the level of the jurisdiction imposing the tax. Known values: city, country, county, district, state
state	JSON	Optional
state (anyOf 1)	string	Alternative	[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. Maximum length: 5000
state (anyOf 2)	null	Alternative

Retrieve a Calculation's line items — response body — data item tax breakdown array item tax rate details value display name, percentage decimal, tax type

Field	Type	Presence	Description and constraints
$	object	Root
display_name	string	Required within parent	A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)". Maximum length: 5000
percentage_decimal	string	Required within parent	The tax rate percentage as a string. For example, 8.5% is represented as "8.5". Maximum length: 5000
tax_type	string	Required within parent	The tax type, such as `vat` or `sales_tax`. Known values: admissions_tax, amusement_tax, attendance_tax, communications_tax, digital_excise_tax, entertainment_tax, gross_receipts_tax, gst, hospitality_tax, hst, igst, jct, lease_tax, luxury_tax, mass_transit_parking_tax, parking_tax, pst, qst, recycling_fee, resort_tax, retail_delivery_fee, rst, sales_tax, service_tax, tourism_tax, utility_users_tax, vat

Retrieve a Transaction's line items — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	A Tax Transaction Line Item represents an individual item in a Tax Transaction.
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_tax	JSON	Required within parent
amount_tax (anyOf 1)	integer	Alternative	The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount_tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.transaction_line_item
product	JSON	Optional
product (anyOf 1)	string	Alternative	The ID of an existing [Product](https://docs.stripe.com/api/products/object). Maximum length: 5000
product (anyOf 2)	null	Alternative
quantity	JSON	Required within parent
quantity (anyOf 1)	integer	Alternative	The number of units of the item being purchased. For reversals, this is the quantity reversed.
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reference	string	Required within parent	A custom identifier for this line item in the transaction. Maximum length: 5000
reversal	JSON	Optional
reversal (anyOf 1)	JSON	Alternative	If `type=reversal`, contains information about what was reversed.
reversal (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a Transaction's line items — response body — data item reversal value original line item
reversal (anyOf 2)	null	Alternative
tax_behavior	string	Required within parent	Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Known values: exclusive, inclusive
tax_code	string	Required within parent	The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. Maximum length: 5000
type	string	Required within parent	If `reversal`, this line item reverses an earlier transaction. Known values: reversal, transaction

Referenced models: Retrieve a Transaction's line items — response body — data item reversal value original line item

Retrieve a Transaction's line items — response body — data item reversal value original line item

Field	Type	Presence	Description and constraints
$	object	Root
original_line_item	string	Required within parent	The `id` of the line item to reverse in the original transaction. Maximum length: 5000

Update settings — response body

Field	Type	Presence	Description and constraints
$	object	Root	You can use Tax `Settings` to manage configurations used by Stripe Tax calculations. Related guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api)
defaults	Model	Required within parent	Expand Update settings — response body — defaults
head_office	JSON	Optional
head_office (anyOf 1)	JSON	Alternative	The place where your business is located.
head_office (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — billing
head_office (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.settings
status	string	Required within parent	Whether these settings have the information Stripe Tax needs to calculate tax. It doesn't reflect whether your integration is ready to collect tax. Known values: active, pending
status_details	Model	Required within parent	Expand Update settings — response body — status details

Referenced models: Create a cardholder — response body — billing, Update settings — response body — defaults, Update settings — response body — status details

Update settings — response body — defaults

Field	Type	Presence	Description and constraints
$	object	Root
provider	string	Required within parent	The tax calculation provider this account uses. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). Known values: anrok, avalara, sphere, stripe
tax_behavior	JSON	Optional
tax_behavior (anyOf 1)	string	Alternative	Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. Known values: exclusive, inclusive, inferred_by_currency
tax_behavior (anyOf 2)	null	Alternative
tax_code	JSON	Optional
tax_code (anyOf 1)	string	Alternative	Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. Maximum length: 5000
tax_code (anyOf 2)	null	Alternative

Update settings — response body — status details

Field	Type	Presence	Description and constraints
$	object	Root
active	Model	Optional	Expand Create a Payment Method — response body — zip
pending	Model	Optional	Expand Update settings — response body — status details pending

Referenced models: Create a Payment Method — response body — zip, Update settings — response body — status details pending

Update settings — response body — status details pending

Field	Type	Presence	Description and constraints
$	object	Root
missing_fields	JSON	Optional
missing_fields (anyOf 1)	array	Alternative	The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.
missing_fields (anyOf 1)[]	string	Each item	Maximum length: 5000
missing_fields (anyOf 2)	null	Alternative