API Integration / Default Payment Method API Endpoint (always optional)
Dunning
Adaptive Campaigns
Emails
SMS Nudge
Last Chance Offers
Retries
Card Updates
Alerts
Data & Testing
Cancel Flows
Overview
Getting Started
Testing
Deflections
Cancel Reasons
Targeted Offers
Custom Branding
Segmentation
Analytics & Insights
Integrations
Recharge
Stripe
Braintree
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
Default Payment Method API Endpoint (always optional)
Notify Churn Buster when a customer's default payment method is updated so that analytics can be tracked.
When a customer's default payment method is updated in your billing system, you should consider notifying Churn Buster so that analytics can be properly reported.
This endpoint is optional, though it adds a great layer of depth to your campaign reporting, showing which campaigns were recovered via retry, compared to which campaigns were recovered via card update.
- Add a trigger in your in-house logic, or subscribe to a webhook from your payment processor or subscription management tool, when customer default payment methods are updated.
- When that trigger occurs or the webhook is received, submit the following API request to Churn Buster.
- 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/payment_methods" \
-H "Content-Type: application/json" \
-u "ACCOUNT_ID:API_KEY" \
-d $'{
"payment_method": {
"source": "in_house",
"source_id": "card_abc123",
"type": "card",
"properties": {
"brand": "visa",
"funding": "debit",
"last4": "1234",
"exp_month": 9,
"exp_year": 2022
}
},
"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.