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