Stripe Billingでサブスクリプション請求を始める時は、テストクロックを設定しよう


サブスクリプションシステムの構築では、運用が始まってから発覚する運用フローやオペレーションが少なくありません。

例えば、「クレジットカードの有効期限が切れたにも関わらず、カード情報を更新していない」ケース。このケースでは、有効期限が切れた後に行われたサブスクリプションの請求が失敗します。

そのため、システムの要件として次のような機能が必要となります。

- 有効期限切れが迫っているクレジットカードを利用している場合、ユーザーにカード更新を促す通知を送信する
- 年間契約などの長期契約では、更新月が迫っていることと、カードの有効期限を確認することをユーザーに通知する
- サブスクリプションの請求が失敗したことを、ユーザーと社内の顧客サポートチームに通知する
- 発行された請求書の決済が失敗している間、有料版機能の利用を制限する
- アプリケーションUIで、カードの更新が必要であることを強調表示する
- 支払い情報が更新された際、請求に失敗しているサブスクリプション請求書への再決済を行う
- 一定期間を過ぎてもカード情報が更新されない場合、利用停止や解約処理を行う


また、支払いが失敗した場合に備えて、「予備のクレジットカードを登録する」仕組みを作るのも有効です。

例えばCloudflareでは、ユーザーに予備のカード情報を登録するように案内やメール通知を行っています。

https://developers.cloudflare.com/fundamentals/setup/account-setup/create-billing-profile/#add-backup-payment-method

### [Tips] Stripe Billingで、失敗した請求にノーコードで対応する

Stripe Billingを利用している場合、ダッシュボードから再請求や顧客への通知・決済情報の更新リンク送付を設定できます。

![スクリーンショット 2023-10-10 15.45.39.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2366300/df114b59-cd56-4dab-1d59-fa1ffd072980.png)
https://dashboard.stripe.com/settings/billing/automatic

![スクリーンショット 2023-10-10 15.40.19.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2366300/02b36e43-a18a-e3bc-91b3-e8f8c8f68ae5.png)
https://dashboard.stripe.com/settings/billing/automatic

また、上位プランである「Biiling Scale」を利用すると、再請求のサイクルを機械学習ベースで最適化したり、「カード情報の更新ページ」をStripeが用意するもので案内することができます。

https://stripe.com/jp/billing/pricing

## 「時間経過による状態変化」は、テストが困難

サブスクリプションでは、「カードの有効期限切れ」以外にも様々な時間経過によるイベントが発生します。

- 契約期間中の解約（即時サービス利用を停止するか、期間終了後まで待つか）
- 契約期間中のプラン変更（差額の請求タイミングやダウングレード時の相殺方法）
- トライアル期間の終了（利用停止のみか、アカウント削除までするか）

このような時間経過を伴うイベント・状態変化をテストするため、Stripeでは**テストクロック機能**を提供しています。

![](https://camo.qiitausercontent.com/9a05204291d7fb161eb30f99dee7736e6852f072/68747470733a2f2f71696974612d696d6167652d73746f72652e73332e61702d6e6f727468656173742d312e616d617a6f6e6177732e636f6d2f302f323336363330302f38353263646235312d666438332d383434352d306565342d3463643637353563306631312e706e67)

https://stripe.com/docs/billing/testing/test-clocks

### テストクロックで、サブスクリプションの時間経過をテストする

Stripeのテストクロックでは、「Stripeの顧客データの時間を、任意の年月日に変更する」ことができます。

![](https://camo.qiitausercontent.com/1959389bdc4b1365808467c5f401141de7c4ee94/68747470733a2f2f71696974612d696d6167652d73746f72652e73332e61702d6e6f727468656173742d312e616d617a6f6e6177732e636f6d2f302f323336363330302f38393234396237322d313736612d356138622d666261392d3139396366333037313230392e706e67)

変更したい時間を指定すると、その時間にたどり着くまでに発生するサブスクリプションの請求やスケジュールされたプラン変更などをシミュレーションし、Stripe Webhookのイベントも発火します。

これによって、「有効期限が切れたカードを使い続けると、サブスクリプション契約はどうなるか？」や「契約期間途中のプラン変更で、次の請求がいくらになるか？」といった時間経過が関連する出来事のシミュレーションが簡単に行えるようになります。

## テストクロックを、アプリケーションに組み込む方法

テストクロックを利用できるようにするには、「APIが作成するCustomerデータをテストクロックに紐付け」する必要があります。

そこで開発時のポイントを簡単に紹介します。

### 設計時のポイント

テストクロックをアプリケーションに組み込む場合、「**１つのテストクロックに設定できるCustomer数に限りがあること**」に注意が必要です。複数人でテストクロックを共有した場合、テストクロックの制限によって、申し込みフローがエラーになる恐れがあります。

また、本番環境ではテストクロックは利用できないため、「**テストクロックのIDが指定されていない場合は、テストクロックを利用しない**」仕様にすることをお勧めします。

### テストクロックを作成する

テストに使用するテストクロックオブジェクトを作成しましょう。

ダッシュボードでの作り方は、こちらの記事をご覧ください。

https://qiita.com/hideokamoto/items/42bec78843a5f12529ad

APIやCLIコマンドから作成することもできます。

https://qiita.com/hideokamoto/items/5c7332bce3d5537992df

### 環境変数で、テストクロックIDを設定する

テストクロックを作成後、発行されるIDを取得しましょう。APIやCLIの戻り値か、ダッシュボードのテストクロック詳細画面からIDは取得できます。

![スクリーンショット 2023-10-10 16.10.23.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2366300/46974dfc-9bca-9824-21d6-5553d84c166e.png)

取得したテストクロックIDを、`STRIPE_TESTCLOCK_ID`などの名前で、環境変数に設定しましょう。

```env
STRIPE_TESTCLOCK_ID=clock_xxx
```

### 環境変数を利用して、テストクロックを適用するかを判断する

テストクロックIDを取得する関数を作成します。関数にすることで、「本番環境では環境変数を無視して`null`を返す」などの条件分岐の追加・変更が容易になります。

```js
export const getStripeTestclockId = () => {
    // StripeのAPIキーに'live'が含まれている場合は、本番環境と判定する
    if (process.env.STRIPE_SECRET_API_KEY?.includes('live')) {
        return null;
    }
    return process.env.STRIPE_TESTCLOCK_ID;
}
```

この例では、StripeのAPIキーに`live`が含まれている場合を持って、本番環境と判定しています。
これ以外にも、`NODE_ENV`やLaravelの`app()->isProduction()`など、言語・フレームワークから本番環境を判定することも可能です。

### テストクロックを顧客・サブスクリプションに設定する

取得したテストクロックIDを利用して、作成する顧客・サブスクリプションデータをテストクロックに紐付けましょう。

テストクロックはStripeのCustomerデータに紐付けします。そのため、Customer作成時のAPIリクエストに、テストクロックのIDを追加しましょう。

```javascript
    const testClockId = getStripeTestclockId()
    const customer = await stripe.customers.create({
        name: 'xxx',
        test_clock: testClockId || undefined
    })
```

`test_clock`が`undefined`の場合は、Customerデータはどのテストクロックにも割り当てされません。そこでテストクロック取得関数`getStripeTestclockId`の戻り値が`null`や`undefined`の場合は、`undefined`を渡すように実装しています。

あとは作成したCustomerデータを利用して、サブスクリプションやCheckout Sessionを作成すればOKです。

サブスクリプション申し込みを受け付けるCheckout Sessionにテストクロックを追加する場合のコード差分を、次に紹介します。

```diff_javascript
+    const testClockId = getStripeTestclockId()
+	const customer = await stripe.customers.create({
+        test_clock: testClockId || undefined
+	})
	const session = await stripe.checkout.sessions.create({
+		customer: customer.id,
+		customer_update: {
+			name: 'auto',
+		},
		mode: 'subscription',
		line_items: [{
			price: 'price_xxxx',
			quantity: 1
		}],
		success_url: 'http://example.com',
	})
    return c.json(session)
```

### Stripe Webhookで、顧客・サブスクリプションデータの削除に対応する

作成したテストクロックは、作成から30日が経過すると自動的に削除されます。

そのため、Stripe側で削除されたテストデータがアプリケーション側のDBに残らないように連携処理を作る必要があります。

- `customer.subscription.deleted`: そのサブスクリプションが削除・解約された時に呼び出されるWebhookイベント
- `customer.deleted`: そのCustomerが削除された時に呼び出されるWebhookイベント

この２つのWebhookイベントを処理するAPIを用意し、必要に応じてアプリケーション側のユーザーデータやDB情報を削除・更新するようにしましょう。

Webhook APIは、Stripeのドキュメントを利用して雛形を簡単に作ることができます。

![スクリーンショット 2023-10-10 16.35.23.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/2366300/2016ddfc-3dbe-3922-3e97-98cd5f1c7b02.png)
https://stripe.com/docs/webhooks/quickstart

署名シークレットの検証方法なども、雛形に含まれていますので、ぜひご活用ください。

## まとめ

Stripeでサブスクリプション決済を提供している場合、テストクロックを利用して様々な時間経過イベントをシミュレーションできます。

ただしアプリケーションに組み込む際には、StripeのCustomerオブジェクトを作成する際に、テストクロックのIDを設定する必要があります。また、「１つのテストクロックに設定できるCustomerデータなどに制限がある」ことや「複数人で時間を変更すると、意図しない時間経過が発生する恐れがある」ため、開発者やテストケースごとにテストクロックを作成することをお勧めします。

テストクロックを利用したテスト方法の詳細は、ドキュメントの「テストクロック ユースケース」などをご覧ください。

https://stripe.com/docs/billing/testing/test-clocks#use-cases

また、テストの支払い方法を活用することで、様々な決済シナリオを試すことが可能です。

https://stripe.com/docs/testing#cards

テストクロックを活用して、サブスクリプションシステムの開発をより効率化していきましょう！

## Stripe テストクロックの関連記事

https://qiita.com/kaonaga9/items/682f1571137ae92ff592

https://qiita.com/hideokamoto/items/42bec78843a5f12529ad

https://qiita.com/hideokamoto/items/0d4c0107b230f2fee528

https://qiita.com/hideokamoto/items/5c7332bce3d5537992df