churnkey

Churnkey SDK

React 向けの本番環境対応キャンセルフローです。オープンソースです。分析と AI によるリテンション機能のために、必要に応じて Churnkey に接続できます。

パッケージ

パッケージ	説明
@churnkey/react	キャンセルフローです。すぐに使えるコンポーネント、ヘッドレスフック、またはコアステートマシンを利用できます。React 18 および 19 に対応しています。
@churnkey/node	サーバーサイドでのトークン生成です。Churnkey に請求処理を任せる場合、またはホスト型埋め込みを使用する場合にのみ必要です。
@churnkey/mcp	Model Context Protocol サーバーです。Claude、Cursor、その他の AI エージェントが、Data API キーを使用して Churnkey のデータ（セッション、分析、DSR）をクエリできます。

クイックスタート

npm install @churnkey/react

import { CancelFlow } from '@churnkey/react'
import '@churnkey/react/styles.css'

<CancelFlow
  steps={[
    {
      type: 'survey',
      title: 'Why are you leaving?',
      reasons: [
        {
          id: 'expensive',
          label: 'Too expensive',
          offer: { type: 'discount', couponId: 'STRIPE_SAVE20', percentOff: 20, durationInMonths: 3 },
        },
        { id: 'not-using', label: 'Not using it enough', offer: { type: 'pause', months: 2 } },
        { id: 'missing', label: 'Missing features' },
      ],
    },
    { type: 'feedback', title: 'Anything else?' },
    { type: 'confirm' },
  ]}
  handleDiscount={async (offer) => myBilling.applyCoupon(offer.couponId)}
  handlePause={async (offer) => myBilling.pause({ months: offer.result?.months ?? offer.months })}
  handleCancel={async () => myBilling.cancel()}
  onClose={() => setOpen(false)}
/>

ドキュメントとリソース

• @churnkey/react — API リファレンス、カスタマイズ、ヘッドレスでの使用方法、カスタムステップの種類
• @churnkey/node — createToken と authHash
• @churnkey/mcp — Claude／Cursor／Claude Desktop 向け MCP サーバー
• Churnkey の無料アカウントを作成 — 分析用の appId を取得できます
• churnkey.co — ダッシュボード、ホスト型埋め込み、AI リテンション機能

リポジトリの構成

sdk/
├── packages/
│   ├── react/      @churnkey/react
│   ├── node/       @churnkey/node
│   └── mcp/        @churnkey/mcp
├── apps/
│   └── playground/ internal dev playground
└── scripts/        release + tooling helpers

ローカル開発

pnpm install
pnpm --filter @churnkey/react build
pnpm --filter @churnkey/react test

プレイグラウンドを使用するには、次のようにします。

pnpm --filter @churnkey/react dev    # rebuilds on change
pnpm --filter @churnkey/playground dev   # runs the playground app

ライセンス

MIT