サブスクリプションをキャンセル(トリガー)

このピースでできること

  • Stripeでサブスクリプションがキャンセルされたことを検知したら、ワークフローを開始します。
 

Stripe の接続方法

Stripe のシークレット API キーを入力して接続します。

シークレット API キーの取得手順

  1. Stripe ダッシュボード にログインします
  1. 左メニューの 開発者(Developers) をクリックします
  1. 「API キー(API keys)」 を開きます
  1. 「シークレットキー(Secret key)」 の 「表示(Reveal live key)」 をクリックします
  1. 表示されたシークレットキー( または テスト用 )をコピーします
  1. 接続画面の 「Secret API Key」 欄に貼り付けます
本番環境では から始まるキーを使用してください。テスト目的の場合は から始まるキーを使用できます。
 

ピースの設定項目

1. 顧客 ID(任意)

  • 特定の顧客に絞って検知したい場合に入力します。

取得できる情報

キャンセルされたサブスクリプション1件の情報を取得します。
実際のキー内容・条件
/ / サブスクリプションID・オブジェクト種別・顧客ID。
/ 状態・通貨。
契約項目の配列。各要素の ・・・ など。
/ / 期間末の解約予定フラグ・解約日時・終了日時。応答に含まれる項目を利用できます。
/ 最新の請求書への参照・任意の付加情報。
解約理由など。項目の有無は通知内容によります。
  • Webhook内の を直接返します。 や をラッパーとしてたどる形式ではありません(出力内の は種類を示す値です)。
  • 顧客 IDを指定した場合は、そのIDに一致する通知が対象です。契約終了の通知が対象で、期間末解約の予約だけをこの通知として扱うものではありません。
  • テストはキャンセル済み既存サブスクリプションを最大5件取得します。テスト取得時には、このトリガーに設定した顧客の絞り込みは適用されません。
  • 任意項目・配列の要素は通知内容により異なります。実際の値は受信結果で確認してください。

出力例(抜粋)

後続ステップで使うキーを説明するための架空例です。実際の値や全項目を示すものではありません。