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