更新の保留の参照情報

サポートされる属性

更新の保留の作成には、特定の属性のみを使用できます。これらの属性は、比例配分 (日割り / 秒割り計算) の動作をコントロールするか、新しい請求書を作成します。

以下は、update subscription (サブスクリプションの更新) エンドポイントでサポートされる属性です。

• expand
• payment_behavior
• proration_behavior
• proration_date
• billing_cycle_anchor
• items
  • price
  • quantity
• trial_end
• trial_from_plan
• add_invoice_items

以下は、create subscription item (サブスクリプションの作成) エンドポイントおよび update subscription item (サブスクリプションの更新) エンドポイントでサポートされる属性です。

• expand
• payment_behavior
• proration_behavior
• proration_date
• price
• quantity

更新の保留のライフサイクル

支払いが成功すると、請求書は paid に更新され、その変更は直ちにサブスクリプション に適用されます。支払いが失敗すると、更新された値が Subscription オブジェクトの pending_update ハッシュに追加されます。サブスクリプションの latest_invoice とは、 open ステータスの未払いの請求書を指します。更新リクエストが行われなかったかのように、サブスクリプションはサイクルを続行します。

支払いの失敗を処理する方法は 2 通りあります。これらは、支払い拒否と顧客認証に関係します。これらの問題を解決したら、再度支払いが試行されます。支払いが完了すると変更が適用され、pending_update ハッシュがクリアされます。支払いが再び失敗した場合には、元の期日とともに pending_update ハッシュがサブスクリプションに残り、いずれの変更も適用されません。

更新の保留をキャンセルすると、pending_update ハッシュがクリアされ、関連付けられている変更が破棄されます。

有効期限

更新が失敗した後に必要なアクションをとらなかった場合、請求書は無効になり、pending_update の expired_at を経過した後に更新の保留も破棄されます。この期限は、トライアルの終了日時または最も早い items.current 期間の終了日時のうち、いずれか早い方の日時に設定されます。これらの時間が、更新が行われる時間から 23 時間以上後の場合には、expired_at の日時は更新の呼び出しが行われてから 23 時間後に計算されます。

さらに以下のいずれかが発生した場合には、 Stripe は請求書を自動的に無効化し、更新の保留を削除します。

• サブスクリプションが請求のしきい値に達した。
• サブスクリプションにリンクされたサブスクリプションのスケジュールが新しいフェーズに移行した。

更新の保留イベント

Webhook を使用して、更新の保留に関する以下のイベントをリッスンできます。

更新の保留とサブスクリプションのスケジュール

更新の保留とサブスクリプションスケジュールの両方をサブスクリプションの管理に使用できます。スケジュールのフェーズが変化するときに保留中の更新がある場合には、そのフェーズ移行が発生する前に、その保留中の更新は破棄され、関連する請求書が無効化されます。必要に応じて、フェーズ移行後に更新リクエストを再試行することができます。

使用状況の記録

サブスクリプションに従量ベースのアイテムが含まれる場合、Stripe は保留中の更新請求書で未払いの使用状況記録に対する請求を行います。ただし、保留中の更新の支払いが有効期限前に発生しない場合、Stripe はこれらの使用状況の記録を破棄し、次の請求書で請求されないようにします。さらに、保留中の更新によって従量料金が削除された場合、Stripe は保留中の更新の作成とその結果生じる請求書の支払いの間に報告された使用量をすべて無視し、すべての請求書から除外します。