請求書の支払いに失敗しました(トリガー)
このピースでできること
- Stripeで請求書(Invoice)の支払いが失敗したことを検知したら、ワークフローを開始します。
Stripe の接続方法
Stripe のシークレット API キーを入力して接続します。
シークレット API キーの取得手順
- Stripe ダッシュボード にログインします
- 左メニューの 開発者(Developers) をクリックします
- 「API キー(API keys)」 を開きます
- 「シークレットキー(Secret key)」 の 「表示(Reveal live key)」 をクリックします
- 表示されたシークレットキー( または テスト用 )をコピーします
- 接続画面の 「Secret API Key」 欄に貼り付けます
本番環境では から始まるキーを使用してください。テスト目的の場合は から始まるキーを使用できます。
ピースの設定項目
1. 顧客 ID(任意)
- 特定の顧客に絞って検知したい場合に入力します。
取得できる情報
Stripeの 通知から、支払いが失敗した請求書の情報を取得できます。
| 実際のキー | 内容・条件 |
|---|---|
| / | 対象データのIDと種類。イベント全体のIDではありません。 |
| 対象データの作成日時(Unixタイムスタンプ)。 | |
| Stripe側で設定した追加情報。未設定の場合は空です。 | |
| / | 顧客ID・請求書の状態。 |
| / / / | 請求額・支払い済み額・残額・通貨。金額は通貨の最小単位です。 |
| / | 支払いを試行したか・試行回数。 |
| 次回の支払い試行日時(Unixタイムスタンプ)。再試行がないなどの場合はnullです。 | |
| 請求書ページのURL。通知に含まれる場合に利用できます。 |
- 出力はWebhook内の そのものです。後続ステップでは などを直接参照します。イベント全体の という階層にはなりません。
- 項目の有無やnull、関連IDと展開済みオブジェクトの違いはStripeのAPI版・通知内容・設定によって異なります。
- テストではopenの請求書を最大5件取得します。支払い失敗の履歴がない請求書も含まれ、設定した顧客IDの絞り込みも適用しません。
- 通常通知は指定した顧客IDに一致する請求書だけを出力します。取得データは請求書であり、Chargeの失敗理由とは階層が異なります。
出力例(抜粋)
キーの使い方を示す架空例です。実際の値や全項目を示すものではありません。