API Integration / Successful Payments API Endpoint
Dunning
Adaptive Campaigns
Emails
SMS Nudge
Last Chance Offers
Retries
Card Updates
Alerts
Data & Testing
Cancel Flows
Overview
Getting Started
Deflections
Cancel Reasons
Targeted Offers
Custom Branding
Segmentation
Analytics & Insights
Integrations
Stripe
Loop
Inveterate
Ordergroove
Rivo
Checkout Champ
Skio
Stay AI
Seal Subscriptions
Awtomic
Recharge
Smartrr
PayPal
Braintree
Orb
API
Getting Started with the Churn Buster API
Successful Payments API Endpoint
Failed Payments API Endpoint
Cancellations API Endpoint
Default Payment Method API Endpoint (always optional)
Customer Endpoint
Upcoming Annual Renewals API Endpoint
Webhook Data Reference
Other
FAQ
Successful Payments API Endpoint
Notify Churn Buster of recurring successful payments so recovery campaigns can be ended (if active) and analytics can be tracked.
When a recurring payment succeeds in your billing system, notify Churn Buster. If the customer has an active recovery campaign, this ends it as recovered.
Two-step setup
- 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 recurring payment succeeds. Skip one-off payments; Churn Buster doesn't need those.
- When the trigger fires, send this request:
curl -X "POST" "https://api.churnbuster.io/v1/successful_payments" \
-H "Content-Type: application/json" \
-u "ACCOUNT_ID:API_KEY" \
-d '{
"payment": {
"source": "in_house",
"source_id": "ch_abc123",
"amount_in_cents": 2900,
"currency": "USD"
},
"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.