顧客の電話番号を収集する

電話番号の収集を有効にするには、Checkout セッションを作成する際に、phone_number_collection[enabled] を true に設定します。

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "line_items[0][price_data][unit_amount]"=1000 \
  -d "line_items[0][price_data][product_data][name]"=T-shirt \
  -d "line_items[0][price_data][currency]"=eur \
  -d "line_items[0][quantity]"=2 \
  -d "phone_number_collection[enabled]"=true \
  -d mode=payment \
  --data-urlencode success_url="https://example.com/success" \
  --data-urlencode cancel_url="https://example.com/cancel"

電話番号の収集が有効になっている場合、Checkout は、支払いフォームに「必須の」電話番号フィールドを追加します。配送先住所を収集する場合には、住所フィールドの下に電話番号フィールドが表示されます。それ以外の場合には、Checkout はメールアドレスの入力フィールドの下に電話番号のフィールドを表示します。顧客は 1 回のセッションで電話番号を 1 件のみ入力できます。

セッション後、Customer オブジェクトまたは Checkout Session オブジェクトから顧客の電話番号を取得できます。

• Customer の動作:Checkout は、収集された電話番号を Customer オブジェクトの phone プロパティに保存します。これは、API で Customer オブジェクトを直接取得してプログラムでアクセスするか、Webhook で customer.created イベントをリッスンして取得できます。顧客の電話番号は、ダッシュボードで確認することもできます。
• Checkout Session の動作:顧客の電話番号は、Checkout Session オブジェクトの customer_details ハッシュの customer_details.phone にも保存されます。Checkout セッションが成功すると毎回、Stripe は Checkout Session オブジェクト (および電話番号) が含まれた checkout.session.completed イベントを送信します。これは、Webhook でリッスンできます。

phone プロパティが入力された既存の Customer (顧客) を Checkout Session (Checkout セッション) に渡すと、電話番号フィールドが事前入力されます。

顧客が電話番号を更新すると、この更新された値が Customer オブジェクトの phone プロパティに保持されるようになり、これまで保存されていた電話番号は上書きされます。

カスタマーポータルで電話番号を更新する

カスタマーポータルでは、顧客自らアカウントを管理させることができます (電話番号の更新など)。