インボイスの支払いプランを作成するベータ
インボイスの支払いプランを使用すると、顧客に代わってインボイスの合計金額を別の支払いに分割し、それぞれに異なる支払い期日を設定できます。これによって請求の柔軟性を向上できます。たとえば、まず預金を回収して、後日取引の残額を回収することができます。あるいは、請求金額を、顧客にとって都合のよい期間の、長期にわたる細かい金額の複数の支払いに分割できます。Stripe は顧客に次回行う必要のある支払いについてリマインドメールを送信し、顧客がすでに実行した過去の支払い履歴を表示します。支払いプランの作成には、ダッシュボードと API のどちらも使用できます。
制限事項
支払いプランは、現時点ではベータ機能であるため、いくつかの重要な制限があります。以下の制限が、お客様のユースケースと矛盾しないことを確認してください。
- 支払いプランは、Stripe Revenue Recognition や Stripe Connector for Netsuite ではサポートされていません。
- 支払いプランでは、保存された支払い詳細を使用して顧客に自動請求は行われません。顧客が後続の支払いを行うには、支払いページに戻る必要があります。 支払いプランは
charge_automatically
のインボイスには使用できません。 - Stripe は、後続の支払いを完了するように顧客にリマインドメールを自動的に送信します。これらのメールは、支払い期日の 1 週間前にデフォルトで送信されます。このメールを送信すると、1 回限りの請求書のリマインドメールのスケジュールと設定が上書きされます。 確定済みのインボイスとクレジットノートを顧客に送信の設定を無効にすることで、リマインドメールを無効にできます。
- Connect ユーザーの場合、支払いプランが有効な請求書にプラットフォーム手数料を設定することはできません。PaymentIntents の手数料のみを設定できます。
- 支払いプランに関連する追加のフィールドは、Sigma では使用できません。
- サブスクリプションの請求書には、支払いプランを適用できません。
請求書決済プランへの早期アクセスをご希望の場合
このガイドでは、Invoicing API の amounts_due フィールドを使用して、支払いプランを設定・管理する方法をご紹介します。
補足オブジェクトを作成する
支払いプランを設定する前に、必ず Invoicing API の実装ガイドで概念をご確認ください。この機能を使用するには、Stripe API またはダッシュボードを使用した商品、価格、顧客の作成方法を理解している必要があります。
支払いプランを含むインボイスを作成する
amounts_due フィールドを使用すると、Stripe Invoices で支払いプランを設定できます。この機能を使用するには、インボイスの collection_method を send_invoice
に設定します。支払いプランは、 charge_automatically
インボイスには対応していません。
このセクションでは、支払いプランの一般的な 2 つのユースケースである、柔軟な支払い期間と頭金について説明します。
柔軟な支払い期間
支払いプランは、顧客が支払いやすくするために、請求金額を細かい金額に分割する場合に使用します。たとえば、6,000 USD のインボイスがあり、3 回に分けて顧客に支払ってもらうとします。この場合、以下のように、amounts_due
フィールドを使用して支払いプランを設定できます。
curl https://api.stripe.com/v1/invoices \ -u
: \ -d customer=sk_test_4eC39HqLyjWDarjtT1zdp7dc\ -d collection_method=send_invoice \ -d auto_advance=true \ -d "amounts_due[][amount]=2000" \ -d "amounts_due[][days_until_due]=30" \ -d "amounts_due[][description]=Payment 1" \ -d "amounts_due[][amount]=2000" \ -d "amounts_due[][days_until_due]=60" \ -d "amounts_due[][description]=Payment 2" \ -d "amounts_due[][amount]=2000" \ -d "amounts_due[][days_until_due]=90" \ -d "amounts_due[][description]=Payment 3"{{CUSTOMER_ID}}
頭金
状況によっては、頭金の後に、残額を支払いプランで支払ってもらう場合もあるでしょう。たとえば、インボイスの金額が 5,000 USD で、最初に頭金として 1,000 USD、残額を 2 回に分けて均等額を支払ってもらうとします。その場合、以下のように支払いプランを設定します。
curl https://api.stripe.com/v1/invoices \ -u
: \ -d customer=sk_test_4eC39HqLyjWDarjtT1zdp7dc\ -d collection_method=send_invoice \ -d auto_advance=true \ -d "amounts_due[][amount]=1000" \ -d "amounts_due[][days_until_due]=1" \ -d "amounts_due[][description]=Deposit" \ -d "amounts_due[][amount]=2000" \ -d "amounts_due[][days_until_due]=30" \ -d "amounts_due[][description]=Payment 1" \ -d "amounts_due[][amount]=2000" \ -d "amounts_due[][days_until_due]=60" \ -d "amounts_due[][description]=Payment 2"{{CUSTOMER_ID}}
上記の例では、さまざまな支払い構造のあるインボイスを対象に、amounts_due
を使用して支払いプランを設定する方法を説明しました。留意点として、amounts_due
フィールドの合計金額は、インボイスの最終 amount_due と一致している必要があります。この例のようにすれば、特定のニーズに合わせてカスタムの支払いプランを作成できるようになります。
支払いプランを更新する
インボイスを確定する前に amounts_due
フィールドを更新すると、必要に応じて支払いプランを修正することができます。こうすることで、期日の変更、支払い金額の変更、新しい支払いの追加などの調整を行えるようになります。
days_until_due を使用して支払い期日までの日数を設定するほかに、due_date フィールドを使用して指定の支払い期日を設定することもできます。due_date
フィールドを使用すると、支払いの厳密な日付を指定し、支払いプランのカスタムオプションを増やすことができます。
インボイスの支払いプランを更新する場合の例を以下に示します。
curl https://api.stripe.com/v1/invoices/
\ -u{{INVOICE_ID}}: \ -d "amounts_due[][amount]=1000" \ -d "amounts_due[][due_date]=1677514200" \ -d "amounts_due[][description]=Updated Payment 1" \ -d "amounts_due[][amount]=3000" \ -d "amounts_due[][due_date]=1678132000" \ -d "amounts_due[][description]=Updated Payment 2"sk_test_4eC39HqLyjWDarjtT1zdp7dc
この例では、days_until_due
の代わりに指定の期日を使用するようインボイスの支払いプランを更新しています。また、amounts_due
も新しい支払い金額を表示するように調整したため、インボイスを確定する前に柔軟に支払いプランを修正できることがわかります。
インボイスを確定する
支払いプランを設定し、必要なインボイスアイテムを追加したら、インボイスを確定します。インボイスを確定すると、一切修正できなくなります。支払いプランの更新、インボイスアイテムの追加・削除、インボイス金額や日付の変更も行うことができません。
インボイスを確定する前に、必要なインボイスアイテムが追加されていることを確認します。インボイスアイテムを追加する方法の例を以下に示します。
curl https://api.stripe.com/v1/invoiceitems \ -u
: \ -d customer=sk_test_4eC39HqLyjWDarjtT1zdp7dc\ -d invoice={{CUSTOMER_ID}}\ -d price={{INVOICE_ID}}\ -d currency=usd{{PRICE_ID}}
必要なインボイスアイテムを追加し、支払いプランが正しく設定されていることを確認したら、インボイスの確定に進みます。インボイスを確定する方法の例を以下に示します。
curl https://api.stripe.com/v1/invoices/
/finalize \ -u{{INVOICE_ID}}: \ -X POSTsk_test_4eC39HqLyjWDarjtT1zdp7dc
インボイスを確定したら、支払いのために顧客に送信できます。インボイスの修正は、確定前に行う必要があるため、このステップを実行する前にインボイスの細部を確認してください。確定の詳細については、ステータスの遷移と確定ガイドを参照してください。
インボイスの確定後の操作
初回の支払いの受領前に限り、支払いプランを設定して確定されたインボイスでも、改訂、無効化、回収不能としてマークすることができます。また、支払いプランを Stripe 外で「支払い済みとしてマーク」できるのは、インボイスの未払い請求額の全額に対してのみです。一部金額をマークすることはできません。
一部支払い済みのインボイスの追跡
一部支払い済みの支払いプランのインボイスは、Stripe ダッシュボード全体で一部支払い済みステータスで表示されます。ただし、いずれかのインボイスの支払いが期日までに行われていない場合は、期日超過ステータスが優先されます。API でインボイスのステータスを表示するには、amounts_due と payments フィールドを確認して、有用な情報を取得します。