Churn Buster
Passive Churn Active Churn Results
Sign In See Pricing
Churn Buster
Passive Churn Active Churn Results Sign In See Pricing
API Integration / Upcoming Annual Renewals API Endpoint
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
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
Docs  /  API Integration

Upcoming Annual Renewals API Endpoint

[Optional] Send a branded email to customers notifying them of their upcoming annual renewal. This feature is only available to Enterprise accounts, and requires setup assistance from the Churn Buster team.

  1. 30 days before an annual subscription renews, you can use this API endpoint to notify Churn Buster of the upcoming invoice, and to trigger a branded email to be immediately sent to your customer.
  2. 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.

Emails will only be sent when using your live-mode API key, and this feature is only available to enterprise accounts who've requested access via the Churn Buster team.

curl -X "POST" "https://api.churnbuster.io/v1/upcoming_annual_renewals" \
    -H "Content-Type: application/json" \
    -u "ACCOUNT_ID:API_KEY" \
    -d $'{
  "invoice": {
    "source": "stripe",
    "source_id": "sub_abc123",
    "amount_in_cents": 4999,
    "currency": "USD",
    "renews_at": 1601586083
  },
  "customer": {
    "source": "stripe",
    "source_id": "cus_abc123",
    "email": "sarah@example.com",
    "properties": {
      "first_name": "Sarah",
      "last_name": "Doe"
    }
  }
}

A note about invoice.source_id:
It's possible the upcoming invoice doesn't yet have an ID assigned. In that case, you can use the Subscription ID as the invoice.source_id.

A note about source and source_id:
In most cases, you should use IDs from your payment processor. If you're using Stripe, source would be "stripe" and source_id would be "cus_sampleID".

If that's not possible, you can use IDs from your in-house billing system. source would be "in_house" and source_id would be "yourInternalId".

IDs should be unique to customers, subscriptions, invoices, payment methods, and payments.

Integrates easily with all subscription platforms, or via API

  • Checkout Champ
  • Stripe
  • Shopify
  • Awtomic
  • Skio
  • Stay Ai
  • Recharge
  • Seal Subscriptions
  • OrderGroove
  • Subbly
  • Smartrr
  • Prive
  • Loop
Churn Buster

Established in 2013
Based in San Diego, CA

Questions?
Email support@churnbuster.io

Products
Dunning Cancel Flows Results Pricing Sign In
Compare
Churnkey alternative Butter Payments alternative Chargebee Retention alternative Baremetrics Recover alternative Flycode alternative
Learn
Learn Passive Churn Failure Reasons Recovery Campaigns Recovery Rate Resources
Company
About Partners Security & Compliance Privacy Policy Terms of Service

© Churn Buster, LLC · All Rights Reserved