プログラムでクレジットノートを作成する

Invoicing API を使用して、確定済みの請求書をクレジットノートで調整または返金します。

open または paid の請求書の残高を調整するには、クレジットノートを生成します。

注

ダッシュボードを使用したクレジットノートの処理については、クレジットノートの発行をご覧ください。

クレジットノートを作成するときは、3 つの方法でクレジット金額を適用できます。

請求書のラインアイテムから固定金額を割引します。
請求書のラインアイテムから数量を割引します。合計割引額は、割引数量にラインアイテムの単価を乗算した値になります。
説明、数量、単価を含むカスタム割引ラインアイテムを追加し、請求書の合計額に割引を適用します。合計割引額は数量に単価を乗算した値になります。

Stripe では、各クレジットをラインアイテムと関連付けているため、可能な場合は請求書のラインアイテムを割引することをお勧めしています。カスタム割引ラインアイテムを追加すると、クレジットが実際の請求書のラインアイテムに関連付けられないため、レポート作成と追跡が困難になる場合があります。

注

請求書のラインアイテムで割引タイプを組み合わせることはできません。たとえば、ラインアイテムの数量を割引すると、将来のクレジットノートではそのラインアイテムを、金額ではなく数量のみで割引できます。ラインアイテムの金額を割引すると、将来のクレジットノートではそのラインアイテムを、数量ではなく金額でのみ割引できます。

未払いの請求書に対するクレジットノート

open 請求書のクレジットノートにカスタムのラインアイテムを作成すると、請求書の amount_due はクレジットノートの custom_line_items に基づいて減額されます。これは、既存の invoice_line_items に対するすべての調整に加えて処理されます。たとえば、open 請求書の未払い額が 100 USD で、quantity=1 と unit_amount=2000 を指定して custom_line_item を作成すると、請求書の新しい金額は 80 USD になります。

請求書では、クレジットノートは割引と税金が適用された後のアイテムとして表されるため、これは課税後の調整額です。請求書金額は次の順序で計算されます。

請求書のラインアイテムの合計
割引
課税前の請求書の合計
税金
顧客のクレジット残高
適用されるクレジットノート (総額に対して)
新たな未払い額

請求書にクレジットノートを適用した結果、未払い金額がゼロになる場合、請求書は自動的に paid 状態に移行します。既存のラインアイテムの数量または金額を変更する場合は、請求書 ID、ラインアイテム ID、および新しい数量または金額を渡します。ラインアイテムに数量と金額がある場合、更新できるのは数量のみです。それ以外の場合は、金額のみを変更できます。次の例では、数量を 2 個に調整しています。

クレジットノートにカスタムラインアイテムを作成するには、請求書 ID、説明、数量、および単価を渡します。オプションで税率も設定できます。この例では、クレジットノートに 10 USD のカスタムラインアイテムを作成します。

支払い済みの請求書に対するクレジットノート

paid 請求書に対してクレジットノートを作成する際には、請求書の金額は変化しません。その代わりに、ユーザーは以下の 1 つ以上のオプションを選択できます。

アクション	説明
返金の作成	請求書の支払いを、顧客の支払い方法に返金します。
返金の関連付け	既存の返金を請求書の支払いに関連付けます。
顧客のクレジット残高への貸方記入	顧客のクレジット残高に貸方記入すると、それ以降の請求書に自動的に適用されます。
Stripe 以外でのクレジット処理	Stripe 外で調整された金額を、請求書で貸方記入します。

次の例では、クレジットノートで返金を作成します。

ここでは、クレジットノートで顧客のクレジット残高への貸方記入を作成します。

複数のパラメーターを組み合わせることもできます。請求書の amount から返金額とクレジット額を差し引いた残りの金額は、通常は現金または小切手を使用して Stripe 外でクレジット処理されます。

クレジットノートを無効にする

未払いの請求書の場合にのみクレジットノートを無効にできます。クレジットノートを無効にすると調整が反対仕訳され、請求書の請求金額がクレジットノートの金額分増額されます。クレジットノートを無効にするには、以下を行います。

マイナスのラインアイテムの貸方記帳処理

amount または quantity パラメーターを使用して、マイナスの金額をマイナスの invoice_line_item に貸方記入できます。

たとえば、2 つのラインアイテムが含まれる open の請求書があるとします。

quantity=1 および unit_amount=10000 のプラスのラインアイテム
quantity=1 で unit_amount=-5000 のマイナスのラインアイテム。

この例では、amount パラメーターを使用して、両方のラインアイテムの全額を貸方記入します。

この例では、quantity パラメーターを使用して同じことを行います。

以下の制限が適用されます。

クレジットノートの合計金額はプラスのままである必要があります。
マイナスのラインアイテムに貸方記入される合計金額は、マイナスである必要があります。
マイナスのラインアイテムに貸方記入される合計金額は、ラインアイテムの金額未満にはできません。

custom_line_item にマイナスの金額を貸方記入することもできません。 invoice_line_items ではマイナスの金額のみがサポートされます。