Book a Tour
API Integration / Getting Started with the Churn Buster API
Dunning
Adaptive Campaigns Emails SMS Nudge Last Chance Offers Retries Card Updates Alerts Data & Testing
Cancel Flows
Overview Getting Started Deflections Cancel Reasons Targeted Offers Custom Branding Segmentation Analytics & Insights
Integrations
Stripe Loop Inveterate Ordergroove Rivo Checkout Champ Skio Stay AI Seal Subscriptions Awtomic Recharge Smartrr PayPal Braintree Orb API
Getting Started with the Churn Buster API Successful Payments API Endpoint Failed Payments API Endpoint Cancellations API Endpoint Default Payment Method API Endpoint (always optional) Customer Endpoint Upcoming Annual Renewals API Endpoint Webhook Data Reference
Other FAQ
Docs  /  API Integration

Getting Started with the Churn Buster API

The auth model, the four endpoints you'll use most, and how to wire them up from an in-house subscription stack.

Connect your subscription management system to Churn Buster by sending four event types over the API. These events power recovery campaigns and give you accurate measurement of failed payment recovery.

Setup

  1. Sign in to your Churn Buster account. No account yet? Email support@churnbuster.io.
  2. Get your Test API Keys. Build against test keys first.
  3. Verify your events in the Test Debugger as you send them.
  4. When you're ready to go live, switch to your Live API Keys.

Authentication

Every request uses HTTP Basic auth with your account ID as the username and your API key as the password:

-u "ACCOUNT_ID:API_KEY"

The four core endpoints

Send these four event types and the integration is complete.

1. Failed payments

When a recurring payment fails, notify Churn Buster to start a recovery campaign and track failed payment volume.

→ Failed Payments API Endpoint

2. Successful payments

When a recurring payment succeeds, notify Churn Buster to end any active campaign and track the recovery.

→ Successful Payments API Endpoint

3. Subscription cancellations

When a subscription is canceled, notify Churn Buster to end any active campaign and track the loss.

→ Cancellations API Endpoint

4. Payment method updates (optional)

When a customer's default payment method changes, notify Churn Buster. This splits recovery analytics into retries vs. card updates.

→ Default Payment Method API Endpoint

More endpoints

About source and source_id

These two fields appear throughout the API docs:

  • source: set it to "in_house", or another consistent name that identifies your subscription management system. Use the same value in every request.
  • source_id: the record's ID in your system. Use unique IDs for each customer, subscription, payment method, and payment.

QA and launch

Once all event types are flowing through your Test API Keys and verified in the Test Debugger, request a QA review. We'll coordinate your launch and the switch to Live API Keys.

For the events Churn Buster sends back out, see the Webhook Data Reference.

Questions at any point: support@churnbuster.io, or your dedicated Slack channel.