カスタムフィールドを追加する
Checkout で構築済みの決済ページにさらにフィールドを追加する方法をご紹介します。
注意
カスタムフィールドは、個人情報、保護対象のデータ、機密データ、法律によって制限されている情報の収集には使用しないでください。
決済フォームにカスタムフィールドを追加すると、顧客から追加情報を収集できます。この情報は、支払いの完了後に使用できるようになり、購入のフルフィルメントに利用できます。
制限
- フィールドは 3 つまで使用できます。
setup
モードでは使用できません。- テキストフィールドで対応できるのは 255 文字までです。
- 数値フィールドは、最大 255 桁に対応できます。
- ドロップダウンフィールドでは最大 200 件のオプションを使用できます。
カスタムフィールドを取得する
顧客が Checkout セッションを完了すると、フィールドが入力されたことを示す checkout.session.completed Webhook が送信されます。
以下に checkout.session.completed
ペイロードの例を示します。
{ "id": "evt_1Ep24XHssDVaQm2PpwS19Yt0", "object": "event", "api_version": "2022-11-15", "created": 1664928000, "data": { "object": { "id": "cs_test_MlZAaTXUMHjWZ7DcXjusJnDU4MxPalbtL5eYrmS2GKxqscDtpJq8QM0k", "object": "checkout.session", "custom_fields": [{ "key": "engraving", "label": { "type": "custom", "custom": "Personalized engraving" }, "optional": false, "type": "text", "text": { "value": "Jane", } }], "mode": "payment", } }, "livemode": false, "pending_webhooks": 1, "request": { "id": null, "idempotency_key": null }, "type": "checkout.session.completed" }