Getting Started with the Churn Buster API

This document outlines how to connect your subscription management tool to Churn Buster so the proper events are transferred over for accurate measurement of failed payment recovery.

‍

To get started:

• Sign in to your Churn Buster account, or notify support@churnbuster.io if you don't have an account yet.
• Within your account, you can access your Test API Keys here, along with the Test Debugger to verify events are being sent. Use test keys until ready to go live.

1. Payment Failures

When a recurring payment fails, notify Churn Buster to track the volume of failed payments and monitor outcomes.

• Failed Payment API Endpoint (link to doc)

2. Successful Payments

When a recurring payment succeeds, notify Churn Buster to track successful recoveries.

• Successful Payments API Endpoint (link to doc)

3. Subscription Cancellations

When a subscription is cancelled, notify Churn Buster to track lost recoveries.

• Cancellations API Endpoint (link to doc)

4. Payment Method Updates

When a customer's default payment method is updated, notify Churn Buster. This enhances your analytics by also tracking recovery method: retry vs. card update.

• Default Payment Method API Endpoint (link to doc)

‍

Once all event types are being sent over through your Test API Keys (verified in the Test Debugger), please request a QA review to coordinate an account launch and switch to your Live API Keys.

For help, please contact us anytime at support@churnbuster.io or via your dedicated Slack channel.

Important note about "source" and "source_id":

• Wherever you see source in the API docs, set it to "in_house" or another consistent name that references your in-house subscription management system.
• Wherever you see source_id in the API docs, set it to the ID from within your in-house system, with unique ID's for the Customer, Subscription, Payment Method, etc.