Cancellations API Endpoint

When a subscription is canceled in your billing system, use the Churn Buster API to notify Churn Buster. If the customer has an active recovery campaign, this ends it as lost. Cancellations are one of the four outcomes tracked in recovery analysis.

Also call this endpoint when a subscription is skipped, rescheduled, or paused. It tells Churn Buster the payment no longer needs to be in a recovery process, and the campaign ends.

Two-step setup

1. Add a trigger in your in-house logic, or subscribe to a webhook from your payment processor or subscription management tool, that fires when a subscription is canceled, skipped, rescheduled, or paused.
2. When the trigger fires, send this request:

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"
   }
 }
}'

Verify your requests

• Test mode: view requests in the test debugger.
• Live mode: view recent requests in the live debugger.

About source and source_id

• 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.