カナダのプレオーソリデビットを使用したサブスクリプションを設定する

カナダのプレオーソリデビットを使用したサブスクリプションの作成と請求の方法をご紹介します。

注

Checkout のサブスクリプションモードはまだサポートされていません。この機能が提供されたときに早期アクセスをご希望の場合は、Stripe までお問い合わせいただき、待機リストに登録してください。

商品と価格を作成する
ダッシュボード

Products (商品) は、販売しているアイテムまたはサービスを表します。Prices (価格) は、商品の価格と請求頻度を定義します。これには、商品の価格、受け付ける通貨、および 1 回限りの支払いか継続支払いかが含まれます。商品と価格が数個のみの場合は、ダッシュボードでそれらを作成および管理します。

このガイドでは、例としてストックフォトサービスを使用し、15 CAD の月次サブスクリプションを顧客に請求します。これをモデル化するには、次のようにします。

商品ページに移動し、商品を作成をクリックします。
商品の名前を入力します。オプションで説明を追加して、商品の画像をアップロードできます。
商品税コードを選択します。商品税コードの詳細をご確認ください。
継続を選択します。次に、価格に**15を入力し、通貨として**を選択します。
価格に税金を含めるかどうかを選択します。税金設定のデフォルト値を使用するか、値を手動で設定できます。この例では、自動を選択します。
請求期間で月次を選択します。
その他の料金体系オプションをクリックします。次に、この例の料金体系モデルとして定額を選択します。定額料金とその他の料金体系モデルの詳細をご確認ください。
将来的に特定の価格を整理、クエリ、更新するために、内部価格の説明と検索キー追加します。
次へをクリックします。次に、商品を追加をクリックします。

商品と価格を作成したら、価格 ID を記録しておき、後続のステップで使用できるようにします。ID は料金体系ページで price_G0FvDp6vZvdwRZ のように表示されます。

サブスクリプションを作成する
サーバー側

注

無料のトライアル期間付きのサブスクリプションの作成については、サブスクリプションのトライアルをご覧ください。

payment_behavior パラメーターの値として default_incomplete を指定して、ステータスが incomplete の価格と顧客の Subscription (サブスクリプション) を作成します。

レスポンスには、サブスクリプションの最初の Invoice (請求書) が含まれます。これには請求書の支払いが格納され、Stripe がこのインボイスに対して生成したデフォルトの PaymentIntent と、PaymentIntent オブジェクト全体を渡す代わりに、クライアント側で決済プロセスを安全に完了するために使用できる、confirmation secret が含まれます。latest_invoice.confirmation_secret.client_secret をフロントエンドに返して、支払いを完了します。

支払い方法の詳細と同意書承認を収集する
クライアント側

カナダのプレオーソリデビットを使用するには、プレオーソリデビット利用規約を使用して、1 回限りの引き落としと継続的な引き落としについて顧客から承認を得る必要があります (PAD 同意書を参照)。Mandate (同意書) オブジェクトは、この利用契約と承認を記録します。

Stripe がお客様に代わってサブスクリプションと請求書の同意書を自動的に設定します。顧客が同意書の条件を一度承認するだけで、それ以上介入しなくても、後続のサブスクリプションの支払いは成功します。

顧客が Canadian pre-authorized debitでの支払いをクリックしたときに、Stripe.js を使用してその支払いを Stripe に送信することをお勧めします。Stripe.js は、決済フローを構築するための Stripe の基本的な JavaScript ライブラリです。これにより、実装に関する複雑な処理が自動的に行われ、将来、他の決済手段にも対応できるように実装を簡単に拡張できます。

Stripe.js スクリプトを決済ページに含めるには、このスクリプトを HTML ファイルの head に追加します。

checkout.html
<head>
  <title>Checkout</title>
  <script src="https://js.stripe.com/basil/stripe.js"></script>
</head>

決済ページで以下の JavaScript を使用して、Stripe.js のインスタンスを作成します。

client.js
// Set your publishable key. Remember to change this to your live publishable key in production!
// See your keys here: https://dashboard.stripe.com/apikeys
const stripe = Stripe('pk_test_TYooMQauvdEDq54NiTphI7jx'
);

PaymentIntent オブジェクト全体をクライアントに送信する代わりに、前のステップからの client secret を使用します。これは、Stripe API リクエストを認証する API キーとは異なります。

ただし、client secret は支払いを完了できるため、慎重に取り扱う必要があります。記録したり、URL に埋め込んだり、当該の顧客以外に漏洩することがないようにしてください。

ユーザーがフォームを送信したら、stripe.confirmAcssDebitPayment を使用して、銀行口座の詳細と銀行口座の確認を収集し、同意書を確認し、支払いを完了します。PAD の決済手段を作成するには、payment_method パラメーターの billing_details プロパティに顧客のメールアドレスと口座名義人を含める必要があります。

const form = document.getElementById('payment-form');
const accountholderName = document.getElementById('accountholder-name');
const email = document.getElementById('email');
const submitButton = document.getElementById('submit-button');
const clientSecret = submitButton.dataset.secret;

form.addEventListener('submit', async (event) => {
  event.preventDefault();

  const {paymentIntent, error} = await stripe.confirmAcssDebitPayment(
    clientSecret,
    {
      payment_method: {
        billing_details: {
          name: accountholderName.value,
          email: email.value,
        },
      },
    }
  );

  if (error) {
    // Inform the customer that there was an error.
    console.log(error.message);
  } else {
      // Handle next step based on PaymentIntent's status.
      console.log("PaymentIntent ID: " + paymentIntent.id);
      console.log("PaymentIntent status: " + paymentIntent.status);
  }
});

Stripe.js は、ページ上のモーダル UI をロードして、銀行口座の詳細の収集と銀行口座の確認を処理し、オンライン同意書を提示して承認を収集します。

注

stripe.confirmAcssDebitPayment の完了には数秒かかる場合があります。この間、フォームが再送信されないように無効化し、スピナーのような待機中のインジケーターを表示します。エラーが発生した場合は、それを顧客に表示し、フォームを再度有効化し、待機中のインジケーターを非表示にします。

顧客が即時確認を完了すると、サブスクリプションは自動的に active になります。それ以外の場合は、サブスクリプションが incomplete の状態のままである場合の少額入金による確認の取り扱いについて、以下のセクションをご確認ください。

少額入金で銀行口座を確認する
クライアント側

注

顧客はサブスクリプションに対する少額入金を、サブスクリプションのライフサイクルで通常指定されている 23 時間以内ではなく、10 日以内に確認する必要があります。ただし、この有効期限は請求期間の日付より後にできません。

すべての顧客が銀行口座を即座に確認できるとは限りません。このステップは、顧客が前のステップで即時確認フローからオプトアウトした場合にのみ適用されます。

この場合、Stripe は顧客の銀行口座に 2 回に分けて少額入金を自動的に行います。これらの入金が顧客のオンライン明細書に表示され、ACCTVERIFY 明細書表記が付けられるまでに 1〜2 営業日かかります。

前のステップで行った stripe.confirmAcssDebitPayment メソッドの呼び出しの結果として、requires_action 状態の PaymentIntent が返されます。この PaymentIntent には、確認を完了するための有益な情報を含む next_action フィールドが含まれています。

Stripe は請求書メールで入金の到着予定日を顧客に通知します。このメールには、Stripe がオンラインで提供する確認ページへのリンクが含まれ、顧客はそのページで入金額を確認して銀行口座の確認を完了することができます。

確認の失敗は 3 回までです。この上限を超えると、銀行口座の確認ができなくなります。また、少額入金の確認は 10 日経過するとタイムアウトになります。少額入金がこの期間内に確認されない場合、PaymentIntent は新しい支払い方法の詳細を要求する状態に戻ります。少額入金とは何か、どのように使用するのかを顧客に明確に伝えることで、顧客は確認に関連する問題を回避できます。

オプション: カスタムのメールと確認ページ

カスタムのメール通知の送信を選択した場合は、顧客にメールを送信する必要があります。このためには、next_action オブジェクトの verify_with_microdeposits[hosted_verification_url] の URL を使用して、顧客に確認プロセスを完了するよう指示します。

カスタムメールを送信していて、Stripe がオンラインで提供する確認ページを使用しない場合、Stripe.js を使用して、顧客がこれらの金額をお客様に伝えて銀行口座を確認するためのフォームを自社サイトに作成できます。

stripe.verifyMicrodepositsForPayment(clientSecret, {
  amounts: [32, 45],
});

デフォルトの支払い方法を設定する
サーバー

これで、支払い方法が指定された顧客の有効なサブスクリプションを作成できましたが、この支払い方法は以降の支払いで自動的には使用されません。これ以降もこの支払い方法に自動的に請求するには、Webhook Consumer を使用して、新しいサブスクリプションの invoice.payment_succeeded イベントをリッスンし、デフォルトの支払い方法を設定します。

サブスクリプションのステータスを管理する
クライアント側

初回の支払いが完了すると、サブスクリプションのステータスは active になり、それ以上のアクションは不要になります。支払いが失敗した場合は、ステータスが自動回収設定で設定された Subscription status に変わります。支払いが失敗した場合は顧客にその旨を通知して、別の支払い方法で請求してください。

注

カナダのプレオーソリデビット支払いは、他の支払い方法に再試行スケジュールが設定されている場合でも、自動的に再試行することはありません。

組み込みをテストする

少額入金の確認メールを受信する

銀行口座の詳細を収集し、同意書を承認した後に、サンドボックスで少額入金の確認メールを受信するには、決済手段の詳細を確認する際に、payment_method[billing_details][email] フィールドに {any_prefix}+test_email@{any_domain} の形式でメールアドレスを指定します。

テスト用の口座番号

Stripe では、手動入力の銀行口座の組み込みが本番環境に移行する準備が整ったかどうかを確認するため、テスト用の口座番号をいくつか用意しています。支払いが自動的に成功または失敗するすべてのテスト用の口座は、以下のテスト用の少額入金を使用して確認してから設定を完了する必要があります。

銀行番号	支店番号	口座番号	シナリオ
`000`	`11000`	`000123456789`	少額入金が確認された後、支払いが直ちに成功します。
`000`	`11000`	`900123456789`	少額入金が確認された後、3 分遅延してから支払いが成功します。
`000`	`11000`	`000222222227`	少額入金が確認された後、支払いが直ちに失敗します。
`000`	`11000`	`900222222227`	少額入金が確認された後、3 分遅延してから支払いが失敗します。
`000`	`11000`	`000666666661`	確認用の少額入金の送金が失敗します。
`000`	`11000`	`000777777771`	支払い金額が原因でアカウントの週次支払い金額の上限を超えるため、支払いが失敗します。
`000`	`11000`	`000888888881`	支払い金額がアカウントの取引限度額を超えているため、支払いが失敗します。

サンドボックスで銀行口座確認の成功または失敗を再現するには、少額入金に以下の特定の金額を使用してください。

少額入金の金額	シナリオ
`32` および `45`	口座が無事に確認されます。
`10` および `11`	許容された確認回数の超過をシミュレーションします。
その他の任意の数字の組み合わせ	口座の確認が失敗します。

オプション請求期間の設定

デフォルトでは、サブスクリプションの作成時にその請求サイクルが自動的に設定されます。たとえば、顧客が 9 月 7 日に月額プランのサブスクリプションに登録した場合、それ以降毎月 7 日に請求されます。一部のビジネスでは、顧客に対してサイクルごとに同時に請求できるように、請求サイクルの手動設定を希望する場合があります。billing cycle anchor 引数を使用すると、これを実現できます。

請求サイクルを手動で設定すると、作成されたサブスクリプションと請求サイクルのアンカーとの間の期間の分として比例配分 (日割り / 秒割り計算) された金額が顧客に自動的に請求されます。この期間分を顧客に請求しない場合は、proration_behavior 引数を none に設定できます。請求サイクルのアンカーをトライアル期間と組み合わせ、商品への無料アクセスをユーザーに提供してから、比例配分された金額を請求することもできます。

オプションサブスクリプションのトライアル

無料トライアルを使用すると、顧客はお客様の商品に一定期間請求なしでアクセスできます。トライアル期間を設定するには、trial_end にタイムスタンプを渡します。

注

無料トライアルの使用は、proration_behavior を none に設定した場合とは異なり、無料の継続期間をカスタマイズできます。

payment_behavior 値に default_incomplete を使用してトライアル期間のあるサブスクリプションを開始すると、Stripe は Subscription オブジェクトで pending_setup_intent 値を返します。SetupIntent オブジェクトについて、詳細はドキュメントをご覧ください。

設定を完了するには、サブスクリプションの pending_setup_intent からフロントエンドに client_secret を返します。このステップは初回の請求サイクルで請求を正常に開始するために必要です。

支払い方法の詳細と同意書承認を収集すると少額入金で銀行口座を確認するの手順に従いますが、stripe.confirmAcssDebitPayment ではなく stripe.confirmAcssDebitSetup を使用します。顧客が少額入金による確認を選択した場合は、stripe.verifyMicrodepositsForPayment ではなく stripe.verifyMicrodepositsForSetup を使用する必要があります。

確認されると、SetupIntent はただちに succeeded ステータスに移行し、Stripe はサブスクリプションの default_payment_method を、新規作成された PaymentMethod に自動的に設定します。

請求サイクルのアンカーを無料トライアルに組み合わせることもできます。たとえば、9 月 15 日に顧客に 7 日間の無料トライアルを付与してから、通常の請求期間を 10 月 1 日に開始するとします。この場合、無料トライアルが 9 月 22 日に終了し、請求サイクルのアンカーが 10 月 1 日となるように設定できます。これにより、顧客に 7 日間の無料トライアルが付与され、トライアル終了日から 10 月 1 日までの期間については比例配分された金額が請求されます。10 月 1 日に、顧客は最初の請求期間全体に対する通常のサブスクリプション金額を請求されます。

オプション将来の利用に備えて支払い方法の情報を保存する

後で作成する請求書、サブスクリプション、サブスクリプションスケジュールで自動的に使用できるように、顧客のカナダのプレオーソリデビットの支払い方法を保存することが必要な場合もあります。

この場合、今後の支払いに備えて顧客の支払い方法を保存する意図を表す SetupIntent オブジェクトを使用して実行できます。SetupIntent は、この設定プロセスのステップを追跡します。

今後の支払いに備えてカナダのプレオーソリデビットの詳細を保存の手順に従いますが、サブスクリプションと請求書のオーソリを収集する別の mandate_options を指定します。

SetupIntent が succeeded 状態に達したら、顧客の default_payment_method を更新します。

注