使用量アラートの設定公開プレビュー

アラートを設定して、顧客がメーター使用量のしきい値を超えたときに通知したり、顧客が指定の請求しきい値に達したときに請求書をトリガーしたりすることができます。特定の顧客またはすべての顧客に適用されるアラートを作成できます。

はじめに

アラートを作成する前に、メーターを作成する必要があります。

使用量アラートを作成する

アラートは、Stripe ダッシュボードまたは API を使用して設定できます。

たとえば、顧客の API コールが 100 回に達したときにトリガーされる 1 回限りのアラートを作成することも可能です。顧客の API コールが 100 回に達すると、しきい値を超えたことを知らせる Webhook がお客様に届きます。

Stripe は、One-time per-customer usage alert と呼ばれる使用量アラートを提供しています。このアラートは、顧客が指定された使用量を初めて超えたときにトリガーされ、今後の使用量に関係なく、顧客ごとに 1 回のみトリガーされます。

Webhook をリッスンする

アラートを設定し、そのメーターの使用量を送信すると、Webhook をリッスンします。これらのイベントは、新しいサブスクリプションや請求書の作成など、Stripe でステータスの変更があったときにトリガーされます。

アプリケーションで、Webhook イベントを含む POST リクエストを受け入れるように HTTP ハンドラを設定し、イベントの署名を検証します。

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 
'sk_test_BQokikJOvBiI2HlWgH4olfQ2'

post '/webhook' do
# You can use webhooks to receive information about asynchronous payment events.
# For more information, see https://stripe.com/docs/webhooks.
webhook_secret = ENV['STRIPE_WEBHOOK_SECRET']
payload = request.body.read
if !webhook_secret.empty?

開発中は Stripe CLI を使用し、Webhook を監視してアプリケーションに転送します。開発アプリの実行中に、新しいターミナルで以下を実行します。

stripe listen --forward-to localhost:4242/webhook

本番環境では、ダッシュボードで Webhook エンドポイント URL を設定するか、Webhook エンドポイントを使用します。

制限事項

使用量アラートについては、次の制限事項を考慮してください。

• アラートの判断は、アラートの作成後に報告された使用量データに基づいてのみ行われます。
• メーターと顧客の組み合わせごとに最大 25 件のアラートを作成することができます。ただし、顧客ごとに特定のメーターのアラートを作成することもできます。
• 現在、アラートはテストクロックでは機能しません。