API keys

If you haven't signed up for a Churn Buster account, do that first.

You can view our pricing here. Be sure to choose an Optimize account which supports API integrations. 

The first step is to go to the API settings page under Account and get your credentials.

Now that you know your Account ID and API key, you can start creating test campaigns!

Failed Payments

Sending failed payment information to Churn Buster will start a Campaign for a customer. When you start using your live API key, the Campaign will send a series of emails asking for updated payment information.

Failed payments and other billing events should be monitored and sent to Churn Buster.

Here's an example API request:

curl -X "POST" "https://api.churnbuster.io/v1/failed_payments" \
     -H "Content-Type: application/json" \
     -u super-secret-account-id:supersecretapikey \
     -d $'{
  "payment": {
    "source": "stripe",
    "source_id": "ch_abc123",
    "amount_in_cents": 2900,
    "currency": "USD",
  },
  "customer": {
    "source": "stripe",
    "source_id": "cus_abc123",
    "email": "[email protected]"
  }
}


Ask the team for our full API Documentation to explore the remaining steps of integrating with Churn Buster.

Viewing campaigns

Active Campaigns will show up under Campaigns, along with completed and stopped.

Campaigns will be active until the customer's payment information is updated and a successful payment is made, or the subscription is canceled.

Clicking on the Campaign will show you more detail and give you a chance to preview or send a test email to yourself.

Capture & Reactivating Subscriptions

The last step is to decide where to link your customers from the emails. In some cases, it makes sense to use Churn Buster Capture pages (currently supported for Stripe and Braintree). In other cases, it makes sense to use your existing payment update page, even if it requires a login. 

It really comes down to what happens on your end when a card is updated. If your in-house system (or the subscription management tool you're using) detects the card update, reactivates the subscription, and bills the past-due balance, then you should use the Churn Buster Capture page. If you don't take those actions in response to a card update, then you should link to your existing tools.

Hopefully that gives you enough information to get started and comfortable with Churn Buster. When you're ready to start creating real Campaigns, all you have to do is let us know and start using your live API key!

Did this answer your question?