無料の注文
Checkout では、1 回限りの支払いで無料の注文を処理できます。これには無料のラインアイテムや 100% の割引を使用します。合計金額が 0 の場合、Checkout は顧客から決済手段を収集しません。
注
Checkout API を使用して無料の注文を処理するには、2023-08-16 以降の API バージョンを使用していることを確認してください。
制限事項
現在、ゲスト顧客の無料の注文には対応していません。
無料のラインアイテムを指定して Checkout セッションを作成する
unit_amount が 0 の Price を作成し、それを Checkout セッションの line items 配列に渡します。価格の作成の詳細については、商品および価格をご覧ください。
line_items
配列の price_data パラメーターを使用して無料の価格を渡すこともできます。
割引を作成して顧客が無料で注文できるようにする
クーポン
Checkout セッションを無料にする Coupon を作成します。たとえば、100% 割引のクーポンを作成できます。
適用された割引でセッションを作成するには、discounts 配列の coupon
パラメーターで coupon ID を渡します。
Checkout セッションの合計額以上の金額のクーポンを適用して、無料の Checkout セッションを作成することもできます。
プロモーションコード
プロモーションコードは、クーポン上に作成される顧客向けのコードです。これらのコードは顧客に共有することができ、顧客が Checkout に入力すると、割引の適用を受けることができます。100% 割引クーポンのプロモーションコードを作成して、顧客が無料で注文を作成できるようにします。
Checkout セッションで allow_promotion_codes パラメーターを使用して、ユーザーが引き換えできるプロモーションコードを有効にします。これにより、Checkout にフィールドが表示され、ユーザーはそこにプロモーションコードを入力できるようになります。
顧客は、Checkout セッションの合計額以上の金額のクーポンを適用して、無料で購入することもできます。
その他の割引の適用方法については、割引を追加するをご覧ください。
決済フォームへのリンクと料金表 オプション
2023 年 8 月 17 日以降に作成されたアカウントの場合、支払い用のリンクと料金表はデフォルトで無料の注文に対応しています。2023 年 8 月 17 日より前に作成されたアカウントの場合、支払い用のリンクと料金表で無料の注文を有効にするには、ダッシュボードの Checkout 設定にアクセスしてください。
注意
この機能を有効にすると 3 日間の猶予期間が与えられ、その間は無効にできます。3 日経つと無効にできなくなります。本番環境の決済フォームへのリンクと料金表でこの機能を有効にする前に、テスト環境のフルフィルメントフローでテストします。
テスト環境の決済用のリンクで無料の注文を使用するには、prefilled_email
URL パラメーターに、ローカル部分に +no_cost_orders
のサフィックスを含むメールアドレスを指定します。たとえば、j.appleseed+no_cost_orders@example.com
のようにします。生成された Checkout セッションで、注文総額をゼロに減らす割引を適用できます。
テスト環境の料金表で無料の注文を使用するには、ローカル部分に +no_cost_orders
のサフィックスを含むメールアドレスを、料金表の customer-email
プロパティに指定します (たとえば、j.appleseed+no_cost_orders@example.com
)。結果として得られた Checkout セッションでは、注文総額をゼロに減らす割引を適用できます。
完了した注文を処理する
Checkout セッションが完了したら、確定済みのラインアイテムとその数量に対するリクエストを作成できます。顧客がラインアイテムを削除した場合、それはラインアイテムのレスポンスからも削除されます。完了した Checkout セッションを処理するイベントハンドラの作成方法については、フルフィルメントガイドをご覧ください。
一般的な誤り
無料の注文のフルフィルメントを行うには、PaymentIntent イベントではなく、checkout.session.completed
イベントを処理してください。完了した無料の Checkout セッションでは PaymentIntent の関連付けが行われません。.
完了した無料の注文はダッシュボードで確認できます。無料の注文タブは、1 件以上の無料の注文が完了している場合にのみ表示されます。