Skip to main content

​
SCT05 - Subscription Business Performance Management

Tools for managing subscription-based business models and recurring revenue, enabling automated billing and customer lifecycle management through the API.

​
Overview

This capability provides API access to comprehensive tools for managing subscription-based services, from plan creation to billing automation and churn prevention.

​
Features

FeatureDescription
Plan ManagementCreate and manage subscription plans
Recurring BillingAutomated billing cycles
Analytics & ReportingSubscription metrics and insights
Lifecycle ManagementCustomer journey automation
Churn PreventionPredictive churn analytics

​
Configuration Options

LevelFeaturesAutomation
BasicEssential plan managementManual billing
StandardFull subscription toolsAutomated billing
AdvancedAI-powered optimizationPredictive analytics

​
API Usage

​
Create Subscription Plan

POST /api/v1/subscriptions/plans
Content-Type: application/json
Authorization: Bearer {access_token}

{
  "name": "Professional Plan",
  "billing_cycle": "MONTHLY",
  "price": 49.99,
  "currency": "EUR",
  "features": ["feature_1", "feature_2", "feature_3"],
  "trial_days": 14
}
Response: 
{
  "plan_id": "plan_pro_001",
  "name": "Professional Plan",
  "billing_cycle": "MONTHLY",
  "price": 49.99,
  "currency": "EUR",
  "status": "ACTIVE"
}

​
Create Customer Subscription

POST /api/v1/subscriptions
Content-Type: application/json
Authorization: Bearer {access_token}

{
  "customer_id": "cust_123456",
  "plan_id": "plan_pro_001",
  "payment_method_id": "pm_card_789",
  "start_date": "2024-02-01"
}
Response: 
{
  "subscription_id": "sub_abc123",
  "customer_id": "cust_123456",
  "plan_id": "plan_pro_001",
  "status": "TRIALING",
  "trial_end": "2024-02-15",
  "next_billing_date": "2024-02-15"
}

​
Get Subscription Metrics

GET /api/v1/subscriptions/metrics
Authorization: Bearer {access_token}
Response: 
{
  "mrr": 125000.00,
  "arr": 1500000.00,
  "active_subscriptions": 2500,
  "churn_rate": 2.5,
  "ltv": 850.00,
  "new_subscriptions_mtd": 150
}

​
Webhook Events

{
  "event": "subscription.renewed",
  "subscription_id": "sub_abc123",
  "plan_id": "plan_pro_001",
  "amount": 49.99,
  "next_billing_date": "2024-03-15"
}

​
Integration with Other Capabilities

CapabilityIntegration
SCT04 - Instant PaymentPayment collection
SCT06 - Decision SupportSubscription analytics
SCT10 - Closed-loopWallet-based subscriptions

Subscription APIs

View detailed subscription API specifications

​
Subscription Tier Availability

TierConfiguration Level
StarterNot included
ProfessionalStandard
EnterpriseAdvanced
CustomConfigurable