/api/propensity_upgrade_plan

Header

X-Customer-Api-Id: <uuid>
X-Secret:          <secret>
Content-Type:      application/json

Request Body Schema

{
  "current_plan": "string",        // required: current subscription tier, e.g. "Silver"
  "target_plan":  "string",        // required: desired upsell tier, e.g. "Gold"
  "customers": [
    {
      "customer_id":    "string",  // required
      "features":       {          // required: flat numeric/categorical vector (≤50 attrs)
        "<feature_name>": 123,
        ...
      },
      "label_upgrade":  0 | 1       // optional: 1 if upgraded historically in training data
    }
  ]
}

Example Request Body

{
  "current_plan":"Silver",
  "target_plan":"Gold",
  "customers":[
    {
      "customer_id":"C-3001",
      "features":{
        "months_on_current_plan":8,
        "storage_usage_pct":92,
        "support_tickets_last_30d":4
      },
      "label_upgrade":1
    }
  ]
}

Example Response Body

{
  "predictions":[
    {
      "customer_id":"C-3001",
      "probability":0.86,
      "propensity_tier":"High",
      "interpretation":"High propensity – push personalised upgrade offer."
    }
  ],
  "model_info":{
    "best_algorithm":"CatBoost",
    "roc_auc":0.79,
    "selected_features":["storage_usage_pct","months_on_current_plan","support_tickets_last_30d"],
    "train_rows":4500,
    "test_rows":500
  }
}

Description

Predict each customer’s likelihood to upgrade from their current plan to a more lucrative target tier, returning calibrated probabilities, five-tier propensity labels, and concise interpretations for precision upsell targeting.

Business Usage

• In-app Nudges: Trigger upgrade pop-ups for High & Very High tiers to maximize conversions • CSM Prioritization: Feed top tiers into account-manager dashboards for personalized outreach • Email Campaigns: Send discount offers only to Medium–High prospects; suppress Very Low to reduce fatigue • Pricing Analysis: Compare probability distributions before/after price changes to inform elasticity strategies

← Back to all routes