Collecter les numéros fiscaux des clients avec Checkout

Nouveaux clients

Pour activer la collecte du numéro fiscal pour les nouveaux clients, définissez tax_id_collection[enabled] sur true lors de la création d’une session Checkout.

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"

Clients existants

Créez une session Checkout avec un client existant pour modifier les informations d’identification fiscale recueillies lors du paiement. La session Checkout enregistre le nom de l’entreprise recueilli en tant que nom du client et ajoute le numéro fiscal recueilli à customer.tax_ids. Étant donné que la collecte d’un nom d’entreprise peut remplacer le nom existant du client, vous devez définir customer_update.name sur auto lors de la création de la session 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 mode=payment \
  --data-urlencode return_url="https://example.com/return"

Si vous n’avez pas enregistré les adresses de vos clients existants, vous pouvez baser leur localisation sur l’adresse de facturation ou de livraison saisie lors du paiement. Pour utiliser l’adresse de facturation saisie lors du paiement afin d’évaluer la localisation du client, définissez customer_update.address sur auto. Lorsque le paramètre customer_update.address est défini sur auto, toutes les adresses précédemment enregistrées pour ce client sont remplacées par l’adresse saisie lors du paiement.

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"

Si vous recueillez les adresses de livraison de clients existants, vous devez baser leur localisation sur l’adresse de livraison saisie lors du règlement. Pour ce faire, définissez le paramètre customer_update.shipping sur auto. Lorsque le paramètre customer_update.shipping est défini sur auto, toutes les adresses de livraison précédemment enregistrées pour ce client sont remplacées par l’adresse de livraison saisie lors du paiement.

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"

Cet exemple crée une session en mode payment avec collecte des numéros fiscaux activée. Pour les abonnements, faites les mêmes changements avec le mode défini sur subscription.

Utilisez le composant Tax ID Element de Stripe pour collecter les numéros fiscaux.

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

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 inclut les numéros fiscaux fournis dans l’objet Session correspondant. Lorsqu’une session est finalisée, Checkout génère un événement checkout.session.completed que vous pouvez écouter à l’aide d’un endpoint de webhook. Si vous souhaitez récupérer le numéro fiscal collecté par un objet Session, vous pouvez le trouver dans le tableau customer_details.tax_ids de la session :

{
  "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 enregistre également les dénominations sociales et numéros fiscaux recueillis dans l’objet Customer associé à la session, le cas échéant. Les numéros fiscaux recueillis lors du règlement sont accessibles dans le tableau customer.tax_ids de l’objet Customer. Vous pouvez également retrouver tous les numéros fiscaux enregistrés d’un objet Customer à l’aide de la ressource Tax IDs en définissant le paramètre owner.type sur customer et le paramètre owner.customer sur l’ID du client. Tout nouveau numéro fiscal comporte une dénomination sociale associée, que Checkout enregistre dans la propriété nom de l’objet Customer. De cette façon, la dénomination sociale recueillie apparaît sur toutes les factures d’abonnement de ce client.

Dans les environnements de test, vous pouvez saisir n’importe quelle chaîne de caractères alphanumériques correspondant au format d’un type de numéro fiscal pris en charge (par exemple, DE123456789 pour eu_vat). Vous trouverez une liste complète d’exemples de numéros fiscaux dans notre guide sur les numéros fiscaux des clients. Vous pouvez également utiliser nos numéros fiscaux de test pour tester différents flux d’état de vérification.