ChurnShield
Log inSign up

Quick Start Guide

Get started with ChurnShield in just a few minutes. Follow this guide to set up your account and start monitoring customer health.

Step 1: Create Account

Sign up for a ChurnShield account to get started. The process takes less than 2 minutes.

  1. Visit the signup page
  2. Enter your email address and create a password
  3. Verify your email address
  4. Complete your organization profile
Create Account

Step 2: Get API Key

Generate an API key to authenticate your requests to the ChurnShield API.

  1. Navigate to the API Keys section in your dashboard
  2. Click "Generate New Key"
  3. Copy your API key and store it securely

⚠️ Keep your API key secure and never share it publicly. If compromised, you can revoke it from your dashboard.

Step 3: Install SDK

Choose your preferred language and install our SDK:

npm install @churnshield/node

Step 4: Initialize SDK

Initialize the SDK with your API key:

const ChurnShield = require('@churnshield/node');
const client = new ChurnShield('YOUR_API_KEY');

Next Steps

Explore the API

Learn about all available endpoints and features in our API documentation.

View API Docs

Set Up Stripe Integration

Connect ChurnShield with your Stripe account to automatically import customer and subscription data.

Connect Stripe

Configure Health Scores

Learn how to customize health score factors for your business.

Configure Scores