Cancellations API Endpoint

When a subscription is canceled in your billing system, you need to notify Churn Buster so that a recovery campaign can be ended (if one is active).

You may also want to call this API endpoint when a subscription is skipped, rescheduled, or paused, so that Churn Buster ends the campaign with the assertion that the payment no longer needs to be in a recovery process.

1. Add a trigger in your in-house logic, or subscribe to a webhook from your payment processor or subscription management tool, when subscriptions are canceled, delayed, rescheduled, or paused.
2. When that trigger occurs or the webhook is received, submit the following API request to Churn Buster.
3. You can preview your sandbox API requests in the debugger here if using your test-mode API key, or here if using your live-mode API key.

curl -X "POST" "https://api.churnbuster.io/v1/cancellations" \
    -H "Content-Type: application/json" \
    -u "ACCOUNT_ID:API_KEY" \
    -d $'{
 "subscription": {
   "source": "in_house",
   "source_id": "sub_abc123"
 },
 "customer": {
   "source": "in_house",
   "source_id": "cus_abc123",
   "email": "sarah@example.com",
   "properties": {
     "first_name": "Sarah",      
     "last_name": "Doe"
   }
 }
}

‍

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.