API Use Cases
Here you'll find the most common User Journeys along with the APIs associated with them. These are a supplement to the full REST API specification found in the API Spec section.
User Journeys
This section documents the end-to-end user journeys supported by the Singula Subscriber Management (SSM) platform. Each use case illustrates how a customer, prospect, or subscriber interacts with our services, and how our backend systems respond.
The aim is to provide both a customer-centric view (flow of actions the user experiences) and a system-level view (sequence of API calls and service interactions).
Categories of Journeys
1. New Customer Purchases
Covers the flows for a first-time customer creating an account and completing a purchase:
- Sky subscription using Direct Debit
- Sky subscription using Credit Card
- OTT subscription using Direct Debit
- OTT subscription using Credit Card
- Sky subscription with free trial (Direct Debit / Credit Card)
- OTT subscription with free trial (Direct Debit / Credit Card)
- One-off product using Credit Card
2. Subscriptions with Discounts
Focuses on applying different types of promotions during sign-up:
- Subscription with standard discount
- Subscription with multi-use promo code
- Subscription with unique (single-use) promo code
3. Prospect Customers
Explores journeys where a non-subscribed user interacts with the platform:
- Prospect customer logs in and views details
- Prospect customer subscribes using Credit Card
4. Existing Customers
Illustrates login and account access for returning subscribers:
- Customer authentication
How to Use These Journeys
- Customer Flowcharts highlight the steps a customer sees and performs.
- System Sequences show the underlying service calls, API endpoints, and integrations.
- Each journey includes notes on validation rules, payment flows (Direct Debit, Credit Card, PSP redirects), and discount handling.
Together, these use cases form the foundation for understanding onboarding, subscription management, and purchase flows across the SSM ecosystem.
Additional Resources
Postman projects and Swagger specifications are available on request to support testing, simulation, and integration work. To gain access to these please contact our Help Centre team or your Account Manager.
Updated about 1 month ago