支払い回収の一時停止

決済の回収の一時停止は、サービスを一時的に無料で提供するためによく使用されます。これは、顧客が決済にさらに時間が必要な場合や、1 回以上の請求期間の決済ができない場合に、「猶予期間」と呼ばれることもあります。

Stripe ダッシュボードまたは API で回収を一時停止または再開できます。回収が一時停止されている間も、 サブスクリプション の 請求書 は引き続き生成されますが、これらの請求書の処理にはいくつかのオプションがあります。以下のユースケースを確認して、最適なアプローチを判断してください。

これらのオプションがユースケースに合わない場合には、代わりにサブスクリプションをキャンセルすることを検討してください。

サブスクリプションが一時停止される前に作成された請求書は、お客様が無効にしない限り、再試行され続けます。

サービスを一時的に無料で提供し、支払いを回収しない

サービスを一時的に無料で提供し、請求書で支払いを回収しない場合 (「猶予期間」など) は、サブスクリプションで作成された請求書を無効にすることで、顧客に請求が行われず、サブスクリプションを status=active のままにすることができます。サブスクリプション ID を使用して pause_collection[behavior] を void に、そして pause_collection[resumes_at] を支払い回収を再開する日付に更新します。

curl https://api.stripe.com/v1/subscriptions/
{{SUBSCRIPTION_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "pause_collection[behavior]"=void

resumes_at の日付より前に作成されたすべての請求書は、直ちに無効としてマークされます。Stripe は、その後請求書のメールや Webhook を送信せず、サブスクリプションのステータスは変化しません。

resumes_at の日付を設定しないと、pause_collection の設定を解除するまでサブスクリプションは一時停止されたままになります。

サービスを一時的に無料で提供し、後で支払いを回収する

一時的にサービスを無料で提供し、後で支払いを回収するには、pause_collection[behavior]=keep_as_draft を設定します。回収を再開するタイミングが分かっている場合には、resumes_at でタイムスタンプを渡します。

curl https://api.stripe.com/v1/subscriptions/
{{SUBSCRIPTION_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "pause_collection[behavior]"=keep_as_draft

resumes_at の日付以前に生成された請求書はすべて draft ステータスのままで、auto_advance は false に設定されます。この間、Stripe はこれらの請求書に関するその後の請求書のメールや webhook を送信せず、サブスクリプションのステータスは変わりません。

resumes_at の日付を設定しないと、pause_collection の設定を解除するまでサブスクリプションは一時停止されたままになります。

これらの請求書の支払いを回収する準備ができたら、auto_advance を true に戻します。請求書 ID がない場合には、サブスクリプション ID を使用して status=draft の請求書を確認できます。次に請求書 ID を使用して、 auto_advance=true を更新できます。

curl https://api.stripe.com/v1/invoices/
{{INVOICE_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d auto_advance=true

サービスを一時的に無料で提供し、請求書を回収不能とマークする

サービスを一時的に無料で提供し、サブスクリプションによって生成された請求書を回収不能としてマークする場合は、サブスクリプション ID を使用して pause_collection[behavior] を mark_uncollectible に更新し、必要に応じて pause_collection[resumes_at] を支払い回収を再開する日付に更新します。これにより、ダウンストリームのレポートが正確になり、顧客に請求が行われず、サブスクリプションが status=active のままになります。

curl https://api.stripe.com/v1/subscriptions/
{{SUBSCRIPTION_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "pause_collection[behavior]"=mark_uncollectible

pause_collection[behavior] を mark_uncollectible に設定した場合、サブスクリプションが resumes_at 日より前に作成する新しい請求書に対する有効な支払い回収が停止されます。Stripe は、これらの請求書の今後の請求書メールや Webhook を送信しません。

この一時停止にもかかわらず、Stripe は既存の顧客残高を請求書に適用します。この動作は、請求書を uncollectible としてマークする前に利用可能な資金を使用するのに役立ちます。請求書の total が顧客残高を使用して全額返済される場合、請求書のステータスは paid に設定されます。それ以外の場合、請求書のステータスは uncollectible に設定されます。

resumes_at 日を設定しない場合、pause_collection の設定を解除するまで、サブスクリプションの支払い回収は一時停止されたままになります。

手動での一時停止の解除

支払いの回収を再開するには、サブスクリプションを更新して pause_collection の設定を解除します。

curl https://api.stripe.com/v1/subscriptions/sub_GTbTiykEwMRog0 \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "pause_collection"=

この方法による回収再開は、今後の請求書のみに適用されます。

一時停止とサブスクリプションのスケジュール

If you pause a subscription on a subscription schedule, the scheduled updates still take effect. However, payment isn’t collected while the subscription is paused. When you want to collect payment again, you need to manually unpause the subscription. You also need to update auto_advance to true on any invoices with status=draft that you want to collect payment on.