支払い回収の一時停止
サブスクリプションの支払い回収を一時停止する方法は以下のとおりです。
注意
paused collection
が設定されたサブスクリプションは、status=paused
に移行できません。支払い方法が指定されずに無料トライアル期間が終了した場合のみ、サブスクリプションの status
が一時停止になります。
支払いの回収の一時停止は、サービスを一時的に無料で提供するためによく使用されます。これは、顧客が支払いにさらに時間が必要な場合や、1 回以上の請求サイクルの支払いができない場合に、「猶予期間」と呼ばれることもあります。
Stripe ダッシュボードまたは API で回収を一時停止または再開できます。回収が一時停止されている間もサブスクリプションの請求書は引き続き生成されますが、これらの請求書の処理にはいくつかのオプションがあります。以下のユースケースを確認して、最適なアプローチを判断してください。
ユースケース | API 設定 |
---|---|
サービスを一時的に無料で提供し、支払いを回収しない | behavior=void を使用する |
サービスを一時的に無料で提供し、後で支払いを回収する | behavior=keep_ を使用する |
サービスを一時的に無料で提供し、請求書を回収不能とマークする | behavior=mark_ を使用する |
これらのオプションがユースケースに合わない場合には、代わりにサブスクリプションをキャンセルすることを検討してください。
サブスクリプションが一時停止される前に作成された請求書は、お客様が無効にしない限り、再試行され続けます。
サービスを一時的に無料で提供し、支払いを回収しない
サービスを一時的に無料で提供し、請求書で支払いを回収しない場合 (「猶予期間」など) は、サブスクリプションで作成された請求書を無効にすることで、顧客に請求が行われず、サブスクリプションを status=active
のままにすることができます。サブスクリプション ID を使用して pause_
を void
に、そして pause_
を支払い回収を再開する日付に更新します。
resumes_
の日付より前に作成されたすべての請求書は、直ちに無効としてマークされます。Stripe は、その後請求書のメールや Webhook を送信せず、サブスクリプションのステータスは変化しません。
resumes_
の日付を設定しないと、pause_
の設定を解除するまでサブスクリプションは一時停止されたままになります。
サービスを一時的に無料で提供し、後で支払いを回収する
一時的にサービスを無料で提供し、後で支払いを回収するには、pause_
を設定します。回収を再開するタイミングが分かっている場合には、resumes_
でタイムスタンプを渡します。
resumes_
の日付より前に生成された請求書はすべて draft
ステータスのままで、auto_
は false
に設定されます。この間、Stripe はこれらの請求書に関するその後の請求書のメールや Webhook を送信せず、サブスクリプションのステータスは変化しません。
resumes_
の日付を設定しないと、pause_
の設定を解除するまでサブスクリプションは一時停止されたままになります。
注意
請求書を確定するカスタムロジックを使用している場合には、これらの設定と矛盾しないようにするため、ロジックを無効化または変更する必要があることがあります。
これらの請求書の支払いを回収する準備ができたら、auto_
を true
に戻します。請求書 ID がない場合には、サブスクリプション ID を使用して status=draft
の請求書を確認できます。次に請求書 ID を使用して、 auto_
を更新できます。
サービスを一時的に無料で提供し、請求書を回収不能とマークする
サービスを一時的に無料で提供し、サブスクリプションによって生成された請求書を回収不能としてマークする場合は、サブスクリプション ID を使用して pause_
を mark_
に更新し、必要に応じて pause_
を支払い回収を再開する日付に更新します。これにより、ダウンストリームのレポートが正確になり、顧客に請求が行われず、サブスクリプションが status=active
のままになります。
pause_
を mark_
に設定した場合、サブスクリプションが resumes_
日より前に作成する新しい請求書に対する有効な支払い回収が停止されます。Stripe は、これらの請求書の今後の請求書メールや Webhook を送信しません。
この一時停止にもかかわらず、Stripe は既存の顧客残高を請求書に適用します。この動作は、請求書を uncollectible
としてマークする前に利用可能な資金を使用するのに役立ちます。請求書の total
が顧客残高を使用して全額返済される場合、請求書のステータスは paid
に設定されます。それ以外の場合、請求書のステータスは uncollectible
に設定されます。
resumes_
日を設定しない場合、pause_
の設定を解除するまで、サブスクリプションの支払い回収は一時停止されたままになります。
手動での一時停止の解除
支払いの回収を再開するには、サブスクリプションを更新して pause_
の設定を解除します。
この方法による回収再開は、今後の請求書のみに適用されます。
一時停止とサブスクリプションのスケジュール
サブスクリプションスケジュールでサブスクリプションを一時停止しても、スケジュールされた更新は引き続き有効です。ただし、サブスクリプションが一時停止されている間は、支払いは回収されません。支払いの回収を再開するには、そのサブスクリプションを手動で更新する必要があります。さらに、支払いを回収する status=draft
の請求書に対して、auto_
を true
に更新する必要もあります。