# 支払い回収の一時停止

サブスクリプションの支払い回収を一時停止する方法は以下のとおりです。

支払いの回収を一時停止して、サービスを一時的に無料で提供することができます。これは、顧客が支払いにさらに時間が必要な場合や、1 回以上の請求期間の支払いができない場合などに、猶予期間と呼ばれることもあります。

支払いの回収を一時停止した場合、*サブスク* (A Subscription represents the product details associated with the plan that your customer subscribes to. Allows you to charge the customer on a recurring basis)は `active` のまま維持され、*請求* (Invoices are statements of amounts owed by a customer. They track the status of payments from draft through paid or otherwise finalized. Subscriptions automatically generate invoices, or you can manually create a one-off invoice)も引き続き生成されますが、Stripe は支払いを回収しません。この期間中、顧客は引き続きサービスを利用できます。

## Before you begin

- 顧客のサービスの利用、支払いの回収、請求を一時停止する場合は、代わりに[サブスクの一時停止](https://docs.stripe.com/billing/subscriptions/pause.md)をご覧ください。
- 更新を完全に停止する場合は、代わりに[サブスクのキャンセル](https://docs.stripe.com/billing/subscriptions/cancel.md)をご覧ください。
- サブスクを一時停止する前に作成された請求は、[無効](https://docs.stripe.com/api/invoices/void.md)にしない限り引き続き[再試行](https://docs.stripe.com/invoicing/automatic-collection.md)されます。

## 支払いの回収の一時停止

支払いの回収を一時停止するには、ダッシュボードまたは API を使用します。

支払いの回収を無期限に一時停止するか、将来の特定の日時に自動的に再開するかを選択できます。支払いの回収が一時停止されている間、Stripe はこれらの請求に対する今後の請求メールや Webhook を送信せず、サブスクのステータスは変更されません。

サブスクの支払いの回収を一時停止する場合、一時停止期間中の請求の処理方法には、以下の 3 つのオプションがあります。

|  |
| **請求を下書きとして保存** (`keep_as_draft`) | - 請求は、`auto_advance` が false に設定された `draft` ステータスで作成されます。
- 後で請求を確定して支払いを回収できます。
  > 請求を確定するカスタムロジックを使用している場合は、これらの設定と矛盾しないよう、ロジックを無効化または変更する必要があります。 |
| **請求を回収不能としてマーク** (`mark_uncollectible`) | - 請求は回収不能としてマークされます。この期間中の支払いは回収されません。Stripe はこれらの請求に対する今後の請求メールや Webhook を送信しません。
- 一時停止されている場合でも、Stripe は既存の顧客残高を請求に適用します。これにより、請求を回収不能としてマークする前に、利用可能な資金を充当できます。請求の合計金額が顧客残高によって全額支払われた場合、請求のステータスは `paid` に設定されます。それ以外の場合、請求のステータスは `uncollectible` に設定されます。 |
| **請求を無効化** (`void`) | 請求は無効化されます。この期間中、請求の記録は作成されません。 |

サブスクの支払いの回収を一時停止するには、以下の手順に従います。

#### ダッシュボード

1. [サブスク](https://dashboard.stripe.com/subscriptions)ページで、該当するサブスクを選択します。

2. オーバーフローメニュー (⋯) をクリックし、**支払いの回収を一時停止**を選択します。

3. 期間を選択します。

   - **無期限**: 再開されるまで、支払いの回収は一時停止されたままになります。
   - **カスタムの日付まで**: 選択した日付に支払いの回収が自動的に再開されます。

4. 請求の動作を選択します。

   - **請求を下書きとして保存**: 請求は下書きとして作成されます。後で請求を確定して支払いを回収できます。
   - **請求を回収不能としてマーク**: 請求は回収不能としてマークされます。この期間中、支払いは回収されません。
   - **請求を無効化**: 請求は無効化されます。この期間中、支払いの記録は作成されません。

5. **一時停止**をクリックします。

#### API

サブスクの支払いの回収を一時停止するには、[サブスクを更新](https://docs.stripe.com/api/subscriptions/update.md)し、`pause_collection[behavior]` を設定します。任意で、`pause_collection[resumes_at]` を設定して、特定の日時に支払いの回収を自動的に再開することもできます。

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

### pause_collection[behavior]

支払いの回収が一時停止されている期間に作成される請求の処理方法を選択します。

- `keep_as_draft`: 回収が一時停止されている間、すべての請求を下書きの状態のままにします。
- `mark_uncollectible`: 回収が一時停止されている間、すべての請求を回収不能としてマークします。
- `void`: 回収が一時停止されている間、すべての請求を無効化します。

### pause_collection[resumes_at]

Unix タイムスタンプ。この時刻を過ぎると、サブスクの支払いの回収が再開されます。

`resumes_at` を設定しない場合、`pause_collection` の設定を解除するまで、支払いの回収は一時停止されたままになります。

> サブスクスケジュールで管理されているサブスクを一時停止した場合でも、スケジュールされた更新は実行されます。サブスクスケジュールのフェーズが移行しても、サブスクに直接設定された `pause_collection` の動作が自動的に削除されることはありません。

## 支払いの回収の再開

サブスクや下書きのままになっている請求の支払いの回収は、ダッシュボードまたは API を使用していつでも再開できます。

### サブスクの回収の再開

#### ダッシュボード

ダッシュボードで支払いの回収を再開するには、以下の手順に従います。

1. [サブスク](https://dashboard.stripe.com/subscriptions)ページで、該当するサブスクを見つけます。
2. オーバーフローメニュー (⋯) をクリックし、**支払いの回収を再開**を選択します。

#### API

支払いの回収を再開するには、[サブスクを更新](https://docs.stripe.com/api/subscriptions/update.md)し、`pause_collection` の設定を解除します。個々のキーに空の値を送信することで、そのキーの設定を解除できます。

#### curl

```bash
curl https://api.stripe.com/v1/subscriptions/sub_GTbTiykEwMRog0 \
  -u <<YOUR_SECRET_KEY>>: \
  -d "pause_collection"= 
```

### 下書きの請求の支払いの回収

サブスクからの支払いの回収を再開した後、下書きの各請求で `auto_advance=true` を設定します。請求 ID がわからない場合は、サブスク ID を使用し、`status=draft` でフィルタリングして検索します。

#### ダッシュボード

サブスクからの支払いの回収を再開した後、下書きの各請求に対して以下の手順を実行します。

1. ダッシュボードの[請求ページ](https://dashboard.stripe.com/invoices/)に移動し、該当の請求をクリックして詳細ページを表示します。
2. オーバーフローメニュー (⋯) をクリックします。
3. **自動回収を有効化**をクリックします。これにより、請求の `auto_advance` プロパティが `true` に変更されます。

#### API

サブスクの下書きの請求を取得します。

```curl
curl -G https://api.stripe.com/v1/invoices \
  -u "<<YOUR_SECRET_KEY>>:" \
  -d "subscription={{SUBSCRIPTION_ID}}" \
  -d status=draft
```

次に、下書きの各請求の `auto_advance` を `true` に設定します。

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

## See also

- [サブスクの一時停止](https://docs.stripe.com/billing/subscriptions/pause.md)