Collect customer tax IDs

New customers

To enable tax ID collection for new customers, set tax_id_collection[enabled] to true when creating a Checkout Session.

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d ui_mode=custom \
  -d "line_items[0][price]"=
{{PRICE_ID}} \
  -d "line_items[0][quantity]"=1 \
  -d "tax_id_collection[enabled]"=true \
  -d mode=payment \
  --data-urlencode return_url="https://example.com/return"

Existing customers

Create a Checkout Session with an existing customer to add any tax ID information collected during checkout. The session saves the business name as the customer’s name, and adds the collected tax ID to customer.tax_ids.

When creating the Checkout Session, you must set customer_update.name to auto to prevent overriding the customer’s existing [name].

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d ui_mode=custom \
  -d customer=
{{CUSTOMER_ID}} \
  -d "line_items[0][price]"=
{{PRICE_ID}} \
  -d "line_items[0][quantity]"=1 \
  -d "tax_id_collection[enabled]"=true \
  -d "customer_update[name]"=auto \
  -d mode=payment \
  --data-urlencode return_url="https://example.com/return"

If you don’t have saved addresses for existing customers, you can use the billing or shipping address entered during checkout to assess their location. To use the billing address, set customer_update.address to auto. Setting this parameter to auto replaces the customer’s previously saved addresses with the address entered during checkout.

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d ui_mode=custom \
  -d customer=
{{CUSTOMER_ID}} \
  -d "line_items[0][price]"=
{{PRICE_ID}} \
  -d "line_items[0][quantity]"=1 \
  -d "tax_id_collection[enabled]"=true \
  -d "customer_update[name]"=auto \
  -d "customer_update[address]"=auto \
  -d mode=payment \
  --data-urlencode return_url="https://example.com/return"

If you’re saving shipping addresses for existing customers, you can use the shipping address entered during checkout to assess their location. To use the shipping address, set customer_update.shipping to auto. Setting this parameter to auto replaces the customer’s previously saved shipping addresses with the address entered during checkout.

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d ui_mode=custom \
  -d customer=
{{CUSTOMER_ID}} \
  -d "line_items[0][price]"=
{{PRICE_ID}} \
  -d "line_items[0][quantity]"=1 \
  -d "tax_id_collection[enabled]"=true \
  -d "customer_update[name]"=auto \
  -d "customer_update[shipping]"=auto \
  -d "shipping_address_collection[allowed_countries][0]"=DE \
  -d mode=payment \
  --data-urlencode return_url="https://example.com/return"

This example creates a session in payment mode with tax ID collection enabled. For subscriptions, make the same changes with the mode set to subscription.

Use Stripe’s Tax ID Element to collect tax IDs.

import {useMemo} from 'react',
import {loadStripe} from '@stripe/stripe-js';
import {CheckoutProvider, TaxIdElement} from '@stripe/react-stripe-js/checkout';

const stripePromise = loadStripe(
'pk_test_TYooMQauvdEDq54NiTphI7jx', {
  betas: [
    'custom_checkout_tax_id_1',
  ],
});

const App = () => {
  const fetchClientSecret = useMemo(() => {
    return fetch('/create-checkout-session', {method: 'POST'})
      .then((res) => res.json())
      .then((data) => data.clientSecret)
  }, []);

  return (
    <CheckoutProvider
      stripe={stripePromise}
      options={{
        fetchClientSecret: () => fetchClientSecret,
      }}
    >
      <TaxIdElement />
    <CheckoutProvider>
  );
};

Checkout は、生成された Session (セッション) オブジェクトに提供された納税者番号を含めます。各セッションの完了後に、Checkout は checkout.session.completed イベントを送信します。これは Webhook エンドポイントでリッスンできます。納税者番号を Session オブジェクトから取得する場合は、セッションの customer_details.tax_ids 配列から取得できます。

{
  "object": {
    "id": "cs_test_a1dJwt0TCJTBsDkbK7RcoyJ91vJxe2Y",
    "object": "checkout.session",
    ...
    "customer": "cus_id_of_new_customer",
    "customer_details": {
      ...
      "tax_ids": [
        {
          "type": "eu_vat",
          "value": "FRAB123456789"
        }
      ]
    },
    ...
    "tax_id_collection": {
      "enabled": true
    },
    ...
  }
}

Checkout はさらに、セッションに Customer (顧客) オブジェクトが関連付けられている場合、収集された納税者番号と企業名をこのオブジェクトに保存します。決済時に収集された納税者番号は、Customer の customer.tax_ids 配列からアクセスできます。また、owner.type パラメーターを customer に、owner.customer を Customer’s ID に指定することで、Customer に保存されたすべての納税者番号を Tax ID リソースで取得することもできます。新しい納税者番号のすべてに関連付けられている企業の正式名称が含まれ、Checkout はそれを顧客の name プロパティに保存します。このようにすることで、収集された法人名がその顧客のサブスクリプションの請求書に常に表示されることになります。

テスト環境では、サポートされている納税者番号タイプの正しい形式で英数字の文字列を入力できます (eu_vat の場合は DE123456789 など)。納税者番号のサンプルの一覧については、Stripe の顧客の納税者番号に関するガイドをご覧ください。また、テスト用納税者番号を使用して、さまざまな確認ステータスのフローをテストすることもできます。