WE'RE HIRING!HELP CENTERINTEGRATIONSSTATUS PAGESIGN UP
These docs are for v2.0. Click to read the latest docs for v2.1.

Overview

Suggest Edits

Cleeng is a Subscriber Retention Management platform for Media and OTT businesses. By providing operational APIs for subscriber management you can easily develop your subscription video platform, create all the offers of your choice and grow your business with actionable analytics. Cleeng is a cloud-based, extremely scalable solution that has ultra-fast API responses around the world so that your viewers will have a great experience.

  • If you are clear about what you want to achieve with Cleeng, go straight to the What would you like to do? section, choose your scenario and start integrating.

  • If you would like to find out some more about Cleeng's offer before you begin, see Key Concepts and check out our User Reference.

  • And don't forget about Cleeng Sandbox. You can register a new sandbox account in no time at all.

What would you like to do?

You can easily achieve your goals with Cleeng's powerful APIs. Choose your scenario below and start integrating for success:

🔸 Integrate a best-in-class purchase flow for OTT.

Go live in a matter of days with MediaStore SDK - a proven purchase flow that is fully compliant with CCPA, GDPR, PCI, PSD2, and more. Take advantage of high-performing APIs, leveraged by 100s of broadcasters, ready to scale.

Follow the Purchase Flow - a recommended option based on MediaStore SDK Components Library.

Note: If you prefer API-based implementation, please refer to Purchase Flow via API.

See our MediaStore SDK Reference Materials to find out more.

🔸 Provide your subscribers an easy way to manage their accounts

Add "My Account" to your website leveraging the MediaStore SDK. Let customers make changes themselves: manage plans, payment methods, and profile details, including consents to marketing communication and terms & conditions.

Follow the My Account - a recommended option based on MediaStore SDK Components Library.

Note: If you prefer API-based implementation, please refer to My Account via API.

See our MediaStore SDK Reference Materials to find out more.

🔸 Integrate seamless payments on mobile and TV apps

Allow viewers to purchase on native apps, and ensure they can watch everywhere. In a smart and robust way, Cleeng handles entitlements across platforms and provides consolidated analytics of your subscriber data.

Follow the Payments on Mobile & TV Apps guide to integrate in-app payments.

🔸 Integrate your preferred payment method with a connector.

Do you require a different payment method? Assemble a payments connector (proxy) and take advantage of the powerful entitlement and billing features of Cleeng Core and get consolidated financial analytics from ChurnIQ.

Follow the Adding a Payment Connector guide to add a payment connector

🔸 Manage plans, offers & pricing through APIs

Manage subscription plans, season passes, pay-per-view, or rentals through the API for any advanced use case. Like administrate what you sell in your own CMS or video management tools, or make scripted price changes.

Follow the Offer & Price Management guide to integrate the offer management feature.

🔸 Upgrade from Classic Checkout to MediaStore SDK

Migrate to MediaStore SDK - a best-in-class open-source solution including high conversion checkout. It is built with React-friendly APIs for a seamless viewing experience on any device.

Follow the Upgrade to MediaStore SDK guide to migrate to MediaStore SDK.

See our MediaStore SDK Reference Materials to find out more.

Key Concepts

The following concepts will give you an overview of Cleeng's offer:

  • Identity management - This component allows you to accelerate sign-ups and enrich user profiles. It comprises:

  • Offer setup - With Cleeng, you can set up a range of versatile offers based on the type of content you're selling including:

    • subscriptions
    • pay-per-view
    • season passes
    • VOD
    • multicurrency offers.

    You can set up offers using the dashboard or Cleeng's API.

  • Payment integration - Cleeng comes with out-of-the-box payment integrations. You can take advantage of payment gateway integrations with leading payment processors, such as Adyen (see Adyen Payment Setup) or PayPal (see PayPal Payment Setup). If you have a payment processing method of your choice, you can also integrate it with Cleeng via a payments connector (see here) and enjoy the benefits of Cleeng Subscriber Retention Management.

  • In-App integrations - Cleeng supports In-App integrations, such as iOS, Android, Roku, Amazon FireTV. Viewers can purchase access to your video content directly from inside your native applications. It ensures a seamless checkout experience without being redirected to the web. For more information see:

  • Checkout implementation - Cleeng offers a smooth checkout experience enhanced by customization options and takes care of payment processing.

    • Full flexibility - Cleeng provides the MediaStore SDK for all merchant clients that enables developers to build and customise a frictionless checkout experience to engage users. The MediaStore SDK provides full flexibility in the design, positioning, and language of all of its elements.

    • Payments with Cleeng MoR - We recommend going with Cleeng being MoR ( Merchant of Record ), as it will reduce the huge burden of you building a payment connector from scratch. With Cleeng being MoR, you get to choose among the two market-leading payment providers Adyen (see Adyen Payment Setup and PayPal (see PayPal Payment Setup ) to process web transactions. All it takes to call exact methods to process the payments and the rest will be handled at Cleeng backend.

    • Non-merchant payments - If you wish to be your own MoR (Merchant of Record), you can contact our BSS Team.

    • Coupons - Cleeng's coupon campaigns allow you to offer discounted coupon codes as an effective small advertisement that will help you attract more viewers, increase sales and improve customer retention.

  • My Account - A solution for viewers to manage their subscriptions by performing such actions as:

    • changing or updating their plans
    • updating payment methods
    • updating profile details
    • managing consents.

  • Viewer Support - It helps you to take care of your customers. It provides means for them to reach out to you when they encounter specific issues when they are using your service. Yet we offer full flexibilities to make sure that the design is well-aligned with your brand and need. By leveraging the viewer support section, you will be able to use the following functionalities:

    • Branded FAQ center
    • Chatbox
    • Contact form

    Please note that viewer support works only with Hi5 license. Hi5 is Cleeng Customer Support service. It is cloud-based, AI-enhanced customer care.

  • ChurnIQ Analytics - ChurnIQ™ is an actionable subscriber data platform designed for OTT & Media businesses. It is built to centralise the key events in the subscriber lifecycle in one place, a place we call the Retention Journey. Its aim is to maximise your ability to track and influence your conversion, retention, and growth performance. Data into ChurnIQ gets populated automatically by using the Operational APIs as explained above. For more information see here.

Cleeng Sandbox

The Cleeng Sandbox is a testing environment that allows you to know the main functionalities of Cleeng's production environment. It is also an environment designed to test implementations and functions.
A few key notes:

  • functions in srm-sandbox.cleeng.com and srm.cleeng.com are the same
  • the sandbox is a separated environment with isolated database
  • your account details, offers, api-keys and transactions are different from your official account
  • the sandbox checkout allows you to apply fake credit cards details in the checkout
  • you can fully play around and try out things, without messing up your main account and your reporting.

In order to use the sandbox you first need to register a new sandbox account and use the API key as provided in the dashboard of the sandbox environment.

If you develop in PHP, and you have loaded the Cleeng PHP SDK you can enable the Sandbox with the following commands:

$cleengApi = new Cleeng_Api();
$cleengApi->enableSandbox();

The card details that you can use for testing are:

Card number: 5555 4444 3333 1111
Card name: any
Card date: 03 / 2030
CVC: 737

📘

Tips!

When you start to work on your integration you might want to understand the exact responses from the API first.

For Medistore SDK, you can use the new API Console

For JSON RPC, you can use the classic console.

User Reference

Our existing clients have integrated MediaStore SDK into their solutions to improve conversion.
If you would like to have a glimpse at those, please click through the links below:

Updated over 2 years ago