Quickstart

npm install @vgpprasad91/churnkit-sdk

import ChurnKit from '@vgpprasad91/churnkit-sdk'

const churn = new ChurnKit({ apiKey: process.env.CHURNKIT_API_KEY! })

await churn.identify('user_123', {
  plan: 'pro',
  mrr: 4900,          // monthly recurring revenue in cents
  email: 'alice@acme.com',
  signedUpAt: '2024-01-15T00:00:00Z',
})

// User is active — positive signal
await churn.event('user_123', 'feature_used', { feature: 'data_export' })
await churn.event('user_123', 'dashboard_viewed')

// Potential churn signals
await churn.event('user_123', 'support_ticket_opened', { severity: 'high' })
await churn.event('user_123', 'export_all_data')

const risk = await churn.score('user_123')

console.log(risk.score)          // 0.73
console.log(risk.tier)           // 'high'
console.log(risk.signals)        // ['no_login_7d', 'support_spike']
console.log(risk.recommendation) // 'Reach out to this user immediately.'

await churn.watch('user_123', {
  threshold: 0.7,
  webhook: 'https://yourapp.com/hooks/churn-alert',
  cooldown: '24h',  // don't fire more than once every 24 hours
})