請求書の複数 (一部) 支払いのサポートを追加しました互換性に関わる変更

新規情報

請求書と クレジットノートでの複数 (一部) の支払いのサポートを導入しています。請求書は過剰支払いもトラックし、帯域外支払いを今すぐトラックできます。さらに、請求書オブジェクトに confirmation_secret フィールドを追加して、Payment Element の使用のサポートを強化しています。

この変更により互換性が失われる理由

• Invoice オブジェクトから payment_intent、charge、paid、paid_out_of_band フィールドを削除しました。
• PaymentIntent オブジェクトと Charge オブジェクトから invoice フィールドが削除されました。
• application_fee_amount フィールドおよび transfer_data フィールドが Invoice オブジェクトから削除されました。Stripe 上で作成された支払いについて、これらのフィールドは Invoice オブジェクトで payments.data.payment.payment_intent を展開することで、これらのフィールドが元となっている PaymentIntent を通じてアクセスできるようになります。
• クレジットノートオブジェクトの refund フィールドを廃止し、refunds 配列に置き換えました。
• Invoice オブジェクトの amount_paid フィールドに不定期決済が反映されるようになりました。

影響

請求書の支払いオブジェクトを導入して、支払いと請求書の関連付けを表し、関連するオブジェクト上の以前の請求書と支払いのポインタを削除しました。1 つの請求書を 1 回の支払いで支払う必要があると想定しないように統合を更新し、新しい請求書の支払いオブジェクトを使用して支払いと請求書の関連付けを理解してください。

invoice.payments] 配列で支払い情報を調べる

payments プロパティを展開すると、請求書オブジェクトとやり取りするときに 請求書.payments] を調べることができます。

curl -G https://api.stripe.com/v1/invoices/{INVOICE_ID} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "expand[]"=payments

invoice.payments 配列は、請求書に関連付けられているすべての決済と、それぞれの割り当てと決済ステータスのリストを提供します。

支払いと請求書接続に新しい Invoice Payment エンドポイントを使用する

Payment Intent と請求書オブジェクト間の接続を理解するには、List Invoice Payment エンドポイントを使用できます。

curl -G https://api.stripe.com/v1/invoice_payments \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "payment[type]"=payment_intent \
  -d "payment[payment_intent]"={PAYMENT_INTENT_ID}

Payment Element の統合に confirmation_secret を使用する

Payment Element の実装、特にサブスクリプションの実装では、以前は invoice.payment_intent.client_secret または latest_invoice.payments.data.payment.payment_intent.client_secret の拡張に依存していましたが、confirmation_secret を展開することで、Invoice オブジェクトの新しい invoice.confirmation_secret.client_secret フィールドを使用できるようになりました。

curl -G https://api.stripe.com/v1/invoices/{INVOICE_ID} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "expand[]"=confirmation_secret

PaymentIntents を使用して application_fee_amount と transfer_data にアクセスする

Invoice オブジェクトから application_fee_amount フィールドおよび transfer_data フィールドが削除されたため、元となっている PaymentIntent を介して Stripe で作成された支払いについてこれらのフィールドにアクセスできるようになりました。請求書の取得時に payments.data.payment.payment_intent を拡張してください。

curl -G https://api.stripe.com/v1/invoices/{INVOICE_ID} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "expand[]"="payments.data.payment.payment_intent"

その後、拡張された PaymentIntent オブジェクトから invoice.payments.data[i].payment.payment_intent.application_fee_amount および invoice.payments.data[i].payment.payment_intent.transfer_data にアクセスできます。これらのフィールドは決済方式が payment_intent のときに Stripe 上で作成された支払いにのみ利用できます。

不定期決済の請求書を特定する

paid_out_of_band フィールドの削除により、invoice.payments プロパティを使用して、帯域外決済の請求書を特定できるようになりました。

請求書が完全に支払われたかどうかを確認するには、インボイスのステータスが paidであること、amount_due が 0 より大きいこと、および invoice.payments 配列内の PaymentIntent type の決済の合計が 0 であることを確認します。

請求書の一部が不定期に支払われているかどうかを確認するには、amount_due が 0 を超え、invoice.payments 配列の PaymentIntent タイプの決済の合計が amount_paid 未満であることを確認します。

変更点

アップグレード