Home
>
API Integration
>
Getting Started with the Churn Buster API

Getting Started with the Churn Buster API

You want to use Churn Buster with your in-house subscription management system or 3rd party subscription management tool? Great choice!

  • First, ask the Churn Buster for a link to sign up for a *sandbox* account (don't use the signup links on the pricing page).
  • Next, make note of your Account ID and API Key here, you'll need them later.
  • Talk with the Churn Buster team (support@churnbuster.io) about your setup to determine which of the following API endpoints you need to set up. In some cases, we can receive certain bits of data directly from your payment processor or subscription management tool.

1. Start campaigns when payments fail

When a recurring payment fails, you need to notify Churn Buster so that a recovery campaign can be started.

Follow these instructions to notify Churn Buster when this happens:

2. Stop campaigns when payments succeed

When a recurring payment succeeds, you need to notify Churn Buster so that a recovery campaign can be ended, if one exists.

Follow these instructions to notify Churn Buster when this happens:

3. Stop campaigns when subscriptions are cancelled, paused, or skipped

When a subscription is cancelled, you need to notify Churn Buster so that a recovery campaign can be ended, if one exists.

Follow these instructions to notify Churn Buster when this happens:

4. Track Changes to the Payment Method (optional)

When a customer's default payment method is updated, you should notify Churn Buster so that your analytics report wins and losses properly.

Follow these instructions to notify Churn Buster when this happens:

Note: While using the sandbox, test campaigns will be created in response to failed payments you send to Churn Buster, but no emails will be sent. Your customers won't be contacted until you decide to launch your account after integration is complete.

  • Important: ¬†disable existing dunning AND pre-expiry emails at launch

Direct integration questions to support@churnbuster.io, or request an onboarding Slack channel to have direct access to our integration team.


When using an in-house subscription management system:

Important:

  • Wherever you see source in the API docs, you should set it to "in_house"
  • Wherever you see source_id in the API docs, you should set it to the ID from within your in-house system for the Customer, Subscription, Payment Method, etc.

When integrating with Chargify:

Subscribe to the following webhook:

  • renewal_failure
  • renewal_success
  • subscription_state_change
  • subscription_card_update

Important:

  • Wherever you see source in the API docs, you should set it to "chargify"
  • Wherever you see source_id in the API docs, you should set it to the ID from within Chargify for the Customer, Subscription, Payment Method, etc.

‚Äć

‚Äć

‚Äć

‚Äć