請求書をプレビューする

請求書のプレビューを作成する方法をご紹介します。

顧客が購入を検討している間に、請求書のプレビューを作成できます。プレビューを作成して、請求書の合計金額を計算し、請求書の各行を取得し、関連する税金や割引を含めます。プレビューを作成すると、請求書を作成せずに顧客に支払いの合計額を表示できます。

たとえば、事業者向けに修理サービスを提供している会社を運営している場合、以下のようにそれぞれ料金や請求スケジュールが異なる複数のアイテムを顧客に提示できます。

アイテム 1: 299 USD の 1 回限りのサービス手数料
アイテム 2: 29 USD の修理用資材 A
アイテム 3: 99 USD の修理用資材 B
アイテム 4: 月額 49 USD のサポートプラン

顧客は、お客様の商品とサービスの組み合わせが異なるとコストがどのように変わるかについて、情報を必要とする場合があります。顧客が 15% 割引の WINTERSALE プロモーションコードを適用してアイテム 1 と 3 の購入を検討している場合は、次の API コールを実行します。

Stripeは、適用される割引および合計金額を示して、各明細行が記載された請求書のプレビューを返します。

{
  "id": "upcoming_in_1OujwkClCIKljWvsq5v2ICAN",
  "object": "invoice",
  "account_country": "US",
  "account_name": "Stripe Docs",
  "account_tax_ids": null,
  "amount_due": 39800,
  "amount_paid": 0,
  "amount_remaining": 39800,
  "amount_shipping": 0,

さらに、生成された請求書のプレビューは、その後 72 時間は /v1/invoices/:id エンドポイントを介して取得できます。

Stripe Tax を含める

Stripe Tax から税額をプレビューするには、automatic_tax[enabled] = true を設定し、customer_details[address] に顧客の住所を渡します。

サブスクリプションの請求書をプレビューする

継続価格が含まれる最初の請求書をプレビューするには、subscription_details.items パラメーターを使用します。

既存のサブスクリプションの変更をプレビューするには、サブスクリプション ID またはサブスクリプションスケジュール ID を指定します。

継続支払いのみをプレビューする

顧客は、1 回限りのアイテムや、一時的なクレジットや割引と併せて継続的なサブスクリプションの購入をしようとする場合があります。調整後の継続支払いを確認する場合は、preview_mode パラメーターを使用して、合計額のプレビューを提供します。

たとえば、WINTERSALE が 1 回限りの 15% 割引であり、顧客がアイテム 1、3、4 を購入ようとする場合、次の API コールで継続支払い額を取得できます。

生成される請求書には、割引のない月額 49 USD のサポートプランのみが記載されます。同様に、preview_mode を subscription または subscription_schedule と組み合わせて、1 回限りのアイテムや割引を除外した、継続的な支払いの推定額を表示することができます。

請求書行のページ分割

10 行を超える請求書については、ページ分割された行のビューを取得できます。