Checkout で顧客の納税者番号を収集する
Checkout で VAT などの顧客の納税者番号を収集する方法をご紹介します。
顧客の納税者番号と法人名を請求書に表示することは一般的な要件であり、この要件を満たすには、Checkout で納税番号の収集を有効にします。このガイドでは、すでに Checkout が導入されていることを前提としています。まだ導入されていない場合は、支払いの受け付けに関するガイドをご覧ください。
納税者番号の収集を有効にする
納税者番号の収集が有効になっていると、Checkout は、顧客の場所に応じて納税者番号収集フォームの表示と非表示を切り替えます。納税者番号収集で対応できる場所に顧客が所在する場合は、顧客が業務上の購入であることを指定できるチェックボックスが表示されます。顧客がこのボックスをチェックすると、顧客企業の納税者番号と正式名称を入力するフィールドが表示されます。顧客の配送先住所が使用できる場合には、Checkout はその住所を使用して顧客の所在地を判断します。配送先住所がない場合は、顧客の請求先住所が使用されます。顧客が入力できる納税者番号は 1 つのみです。
新規顧客
新規顧客の納税者番号の収集を有効にするには、Checkout セッションを作成する際に、tax_id_collection[enabled] を true
に設定します。
この例では、payment
モードで納税者番号の収集が有効化されたセッションを作成します。サブスクリプションの場合は、mode を subscription
に設定して同じ変更を行います。
Checkout をさらに設定して、customer_creation を使用するための Customer を新規で作成することもできます。この場合、Checkout はセッション中に収集された納税者番号情報をその新しい Customer に保存します。それ以外の場合、納税者番号情報を引き続き customer_details.tax_ids で利用できます。
既存の顧客
セッションの作成時に既存の顧客を渡すと、Checkout はセッションで収集された納税番号情報を使用してその顧客を更新します。収集された企業名が顧客の name プロパティに保存され、収集された納税者番号が顧客の customer.tax_ids 配列に追加されます。企業名を収集することにより顧客の既存の Name (名前) オブジェクトが上書きされる可能性があるため、セッション作成時に customer_update.name を auto
に設定する必要があります。
注意
Checkout only collects tax IDs on Customers that don’t already have an existing tax ID. If a Customer has one or more tax IDs saved, Checkout doesn’t display the tax ID collection form even if tax ID collection is enabled.
既存の顧客の納税者番号を収集する場合は、顧客に既存の住所、または決済時に入力された住所に基づいて顧客の所在地を判断できます。デフォルトの場合、Checkout は顧客の既存の住所を調べて、所在地を探します。
既存の顧客に住所の保存を求めていない場合、決済時に入力された請求先住所や配送先住所から所在地を判定できます。顧客の所在地の判定に決済時に入力された請求先住所を使用するように指定するには、customer_update.address を auto
に設定する必要があります。customer_update.address を auto
に設定すると、Checkout では、以前に顧客に保存された住所がセッション中に入力された住所に置き換えられます。
既存の顧客の配送先住所を収集している場合、顧客の住所の判断に決済時に入力された配送先住所を使用する必要があります。これを行うには、customer_update.shipping を auto
に設定します。customer_update.shipping を auto
に設定すると、Checkout では、以前に顧客に保存された配送先住所がセッション中に入力された配送先住所に置き換えられます。
上記のコードサンプルでは、payment
モードで納税者番号の収集が有効化されたセッションを作成します。サブスクリプションの場合は、mode を subscription
に設定して同じ変更を行います。
セッション後に顧客の納税者番号の詳細を取得する
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 プロパティに保存します。このようにすることで、収集された法人名がその顧客のサブスクリプションの請求書に常に表示されることになります。
実装内容をテストする
In test mode, you can enter any alphanumeric string that is in the correct format of a supported tax ID type (for example, DE123456789
for eu_
). For a full list of example tax IDs you can reference our Customer Tax ID guide. You can also use our test tax IDs to test various verification state flows.
検証
Checkout performs checks during the Session to make sure that provided tax IDs are formatted correctly. We don’t verify that provided tax IDs are valid during the Session. You’re responsible for ensuring the validity of customer information collected during Checkout. To help, Stripe automatically performs asynchronous validation against government databases for Australian Business (ABN) numbers, European Value-Added-Tax (EU VAT) numbers, and United Kingdom Value-Added-Tax (GB VAT) numbers. You can read more on the validation we perform, and how to consume the status of those checks in our Customer Tax ID guide.
サポートされる納税者番号の種類
Checkout は、特定の地域で以下の納税者番号を収集します。
国 | 列挙値 | 説明 | 例 |
---|---|---|---|
アイスランド | is_ | アイスランドの VAT | 123456 |
アイルランド | eu_ | European VAT number | IE1234567AB |
アラブ首長国連邦 | ae_ | アラブ首長国連邦の TRN | 123456789012345 |
アルバニア | al_ | アルバニアの納税者番号 | J12345678N |
アルメニア | am_ | Armenia Tax Identification Number | 02538904 |
アンゴラ | ao_ | Angola Tax Identification Number | 5123456789 |
イギリス | eu_ | Northern Ireland VAT number | XI123456789 |
イギリス | gb_ | イギリスの VAT 番号 | GB123456789 |
イタリア | eu_ | European VAT number | IT12345678912 |
インド | in_ | インドの GST 番号 | 12ABCDE3456FGZH |
ウガンダ | ug_ | Uganda Tax Identification Number | 1014751879 |
ウクライナ | ua_ | ウクライナの VAT | 123456789 |
ウズベキスタン | uz_ | ウズベキスタンの TIN 番号 | 123456789 |
ウズベキスタン | uz_ | ウズベキスタンの VAT 番号 | 123456789012 |
ウルグアイ | uy_ | ウルグアイの RUC 番号 | 123456789012 |
エクアドル | ec_ | エクアドルの RUC 番号 | 1234567890001 |
エジプト | eg_ | エジプトの納税者番号 | 123456789 |
エストニア | eu_ | European VAT number | EE123456789 |
オーストラリア | au_ | オーストラリア事業者登録番号 (AU ABN) | 12345678912 |
オーストリア | eu_ | European VAT number | ATU12345678 |
オマーン | om_ | オマーンの VAT 番号 | OM1234567890 |
オランダ | eu_ | European VAT number | NL123456789B12 |
カザフスタン | kz_ | カザフスタンの企業識別番号 | 123456789012 |
カナダ | ca_ | カナダの BN | 123456789 |
カナダ | ca_ | カナダの GST/HST 番号 | 123456789RT0002 |
カナダ | ca_ | カナダの PST 番号 (ブリティッシュコロンビア) | PST-1234-5678 |
カナダ | ca_ | カナダの PST 番号 (マニトバ) | 123456-7 |
カナダ | ca_ | カナダの PST 番号 (サスカチュワン) | 1234567 |
カナダ | ca_ | カナダの QST 番号 (ケベック) | 1234567890TQ1234 |
カンボジア | kh_ | Cambodia Tax Identification Number | 1001-123456789 |
ギニア | gn_ | Guinea Tax Identification Number (Número de Identificação Fiscal) | 123456789 |
キプロス | eu_ | European VAT number | CY12345678Z |
ギリシャ | eu_ | European VAT number | EL123456789 |
クロアチア | eu_ | European VAT number | HR12345678912 |
ケニア | ke_ | ケニア税務当局の個人識別番号 | P000111111A |
コスタリカ | cr_ | コスタリカの納税者番号 | 1-234-567890 |
コンゴ民主共和国(キンシャサ) | cd_ | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | A0123456M |
サウジアラビア | sa_ | サウジアラビアの VAT | 123456789012345 |
ザンビア | zm_ | Zambia Tax Identification Number | 1004751879 |
ジョージア | ge_ | ジョージアの VAT | 123456789 |
シンガポール | sg_ | シンガポールの GST | M12345678X |
ジンバブエ | zw_ | Zimbabwe Tax Identification Number | 1234567890 |
スイス | ch_ | スイスの VAT 番号 | CHE-123.456.789 MWST |
スウェーデン | eu_ | European VAT number | SE123456789123 |
スペイン | es_ | スペインの NIF 番号 (以前のスペインの CIF 番号) | A12345678 |
スペイン | eu_ | European VAT number | ESA1234567Z |
スリナム | sr_ | Suriname FIN Number | 1234567890 |
スロバキア | eu_ | European VAT number | SK1234567891 |
スロベニア | eu_ | European VAT number | SI12345678 |
セネガル | sn_ | Senegal NINEA Number | 12345672A2 |
セルビア | rs_ | セルビアの PIB 番号 | 123456789 |
タイ | th_ | タイの VAT | 1234567891234 |
タジキスタン | tj_ | Tajikistan Tax Identification Number | 123456789 |
タンザニア | tz_ | タンザニアの VAT 番号 | 12345678A |
チェコ共和国 | eu_ | European VAT number | CZ1234567890 |
チリ | cl_ | チリの TIN | 12.345.678-K |
デンマーク | eu_ | European VAT number | DK12345678 |
ドイツ | eu_ | European VAT number | DE123456789 |
トルコ | tr_ | トルコの納税者番号 | 0123456789 |
ナイジェリア | ng_ | ナイジェリアの納税者番号 | 12345678-0001 |
ニュージーランド | nz_ | ニュージーランドの GST 番号 | 123456789 |
ネパール | np_ | Nepal PAN Number | 123456789 |
ノルウェー | no_ | ノルウェーの VAT 番号 | 123456789MVA |
バーレーン | bh_ | バーレーンの VAT 番号 | 123456789012345 |
バハマ | bs_ | Bahamas Tax Identification Number | 123.456.789 |
バルバドス | bb_ | Barbados Tax Identification Number | 1123456789012 |
ハンガリー | eu_ | European VAT number | HU12345678 |
フィンランド | eu_ | European VAT number | FI12345678 |
フランス | eu_ | European VAT number | FRAB123456789 |
ブルガリア | eu_ | European VAT number | BG0123456789 |
ベラルーシ | by_ | ベラルーシの TIN 番号 | 123456789 |
ペルー | pe_ | ペルーの RUC 番号 | 12345678901 |
ベルギー | eu_ | European VAT number | BE0123456789 |
ポーランド | eu_ | European VAT number | PL1234567890 |
ボスニア・ヘルツェゴビナ | ba_ | Bosnia and Herzegovina Tax Identification Number | 123456789012 |
ポルトガル | eu_ | European VAT number | PT123456789 |
マルタ | eu_ | European VAT number | MT12345678 |
メキシコ | mx_ | メキシコの RFC 番号 | ABC010203AB9 |
モーリタニア | mr_ | Mauritania Tax Identification Number (Número de Identificação Fiscal) | 12345678 |
モルドバ | md_ | モルドバの VAT 番号 | 1234567 |
モロッコ | ma_ | モロッコの VAT 番号 | 12345678 |
モンテネグロ | me_ | Montenegro PIB Number | 12345678 |
ラトビア | eu_ | European VAT number | LV12345678912 |
リトアニア | eu_ | European VAT number | LT123456789123 |
リヒテンシュタイン | li_ | リヒテンシュタインの VAT 番号 | 12345 |
ルーマニア | eu_ | European VAT number | RO1234567891 |
ルクセンブルグ | eu_ | European VAT number | LU12345678 |
ロシア | ru_ | ロシアの INN | 1234567891 |
ロシア | ru_ | ロシアの KPP | 123456789 |
北マケドニア | mk_ | North Macedonia VAT Number | MK1234567890123 |
南アフリカ | za_ | 南アフリカの VAT 番号 | 4123456789 |
台湾 | tw_ | 台湾の VAT | 12345678 |
韓国 | kr_ | 韓国の BRN | 123-45-67890 |