Stripe | Financial Infrastructure to Grow Your Revenue

Stripe | Financial Infrastructure to Grow Your Revenue

4466 articles

Create Tax Id Element


Create a Tax ID Element checkout.createTaxIdElement(options?: object) This method creates an instance of a Tax ID Element. > This feature requires the custom_checkout_tax_id_1 beta. To use it, pass betas: ['custom_checkout_tax_id_1'] when initializing Stripe.js. - options Tax ID Element initialization options. - visibility By default, the Tax ID Element displays when the user is in a country that supports tax ID collection. Specify always to display the element regardless of the user's country. Specify never to hide the element completely. When name_collection.business.enabled is true on the Checkout Session and visibility is auto, the element displays regardless of the user's country. In countries that do not support tax ID collection, only the business name field shows. - fields By default, the Tax ID Element collects all tax ID information. If it's not necessary for you to collect all fields, you can disable Tax ID Element collection of certain fields with the fields option. - businessName Specify always to collect the business name. Specify never to not collect the business name. Default is auto. When name_collection.business.enabled is true on the Checkout Session, setting this to never signals that you are collecting the business name through your own input via updateBusinessName() instead. - validation By default, the Tax ID Element will enforce preset validation for each field. You can customize the settings by using this option. - businessName - required Specify always to make business name a required field. Specify never to make business name an optional field. Default is auto. When name_collection.business.enabled is true on the Checkout Session and name_collection.business.optional is false, the SDK overrides this to always regardless of what you set here. - taxId - required Specify always to make tax ID a required field. Specify never to make tax ID an optional field. Default is auto. - verification Configure real-time tax ID verification. Requires the custom_checkout_tax_id_verification_1 beta. To use it, pass betas: ['custom_checkout_tax_id_1', 'custom_checkout_tax_id_verification_1'] when initializing Stripe.js - taxId - mode Specify if_supported to enable real-time tax ID verification for supported tax ID types. Specify never to disable verification. Default is never. ### Example title Create a Tax ID Element

Last verified 2026-09-24

Is this helpful?