This is a step by step guide to include Plugin in your app. This plugin is developed in Kotlin and supports both Java and Kotlin languages.

Pre-Requisites Android SDK supports API 21 (Android 5.0) and above. Please ensure the minSdkVersion is in the app's build.gradle file reflects the same.

In case of an error for Kotlin not enabled - Enable Kotlin for Project.

In case of an error in Manifest merging - Merge Manifest as per Android Studio support or include the below line inside your application tag in the Android Manifest file.



Add the following permissions to the AndroidManifest.xml file.

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

You can download and add AAR File from here, which needs to be included in your Module libs directory, and tell gradle to install it like this:

Both files are required to be added.
dependencies {
    implementation fileTree(include: [ '*.aar'], dir: 'libs')


In root level (project level) build.gradle, add classpath, and maven:

dependencies {
    classpath '[latest-version]'
    // Add the Crashlytics Gradle plugin
    classpath '[latest-version]'

In your application build.gradle file, include dependency as below with the latest versions:

// Retrofit
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
    implementation 'com.squareup.okhttp3:logging-interceptor:5.0.0-alpha.9'
// Coroutines    
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4'
// Browser   
     implementation 'androidx.browser:browser:1.5.0'
     implementation '[latest-version]'
     implementation (platform("[latest-version]"))
     implementation ("")
     implementation ("")
     implementation 'com.squareup.picasso:picasso:[latest-version]'
     implementation "androidx.swiperefreshlayout:swiperefreshlayout:[latest-version]"

Initialize SDK

In your application or root activity class's method onCreate, pass these fields to be used in your app.

  • applicationContext - Pass your application context.

  • yourClientId - Pass your clientId received from

  • yourAccentColor - Pass your accentColor for the app.

  • Mode - configuration testing of different environments available.

  • APP_MODE - used for checking the debug and production environment of the app.

Api Mode can be set as :

APP_MODE can be set as : 

If APP_MODE is DEBUG, all errors will be shown as Toast messages and Logs.

If APP_MODE is PROD, only logs will be available for critical errors like Network unavailability, wrong client_id, and wrong content_id.

class TestingApplication : Application() {
    override fun onCreate() {

            application = this,
            clientId = "5f92a62013332e0f667794dc",
            colorAccent = Color.parseColor("#000000"),
            appMode = ConscentConfiguration.APP_MODE.DEBUG,
            apiMode = ConscentConfiguration.MODE.SANDBOX,

Pass the client ID received from dashboard

Initialize the paywall

In order to ensure that the Paywall appears on the targeted pages and the deep insights and analytics are collected optimally you need to implement the following method on all the content/article pages.

To have more control over the content flow, create an instance of the Conscent class inside your activity onCreate method for each unique contentId(recommended).

Use the below-described method:

val instance = ConscentWrapper.getConscentInstance(
            callingActivity = yourCallingActivity,
            parentView = yourParentView,
            containerView = yourContainerView,
            popUpContainer = yourPopUpContainerView,
            onConscentListener = onConscentListener,
            contentId = contentId,
            title = contentTitle,
            categories= arrayListOf("categorie1","categorie2","categorie3"),
            sections = arrayListOf("section","section1","section3"),
            tags = arrayListOf("premium"),
            url = ContentUrl,
            authorName = authorName,
//To display the registration paywall 
 //To display the paywall       
//To display the metered banner

Note: Include the AAR files of respective paywalls and banners before calling above functions.

To set the scroll depth on the content page:

instance.scrollDepth = scrollY

Call the below sample method on override onActivityResult in Activity Class.

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)

        Log.i(TAG, "RedirectionHandler.onActivityResult: ")
        if (resultCode == RESULT_OK) {
            if (data?.getStringExtra("TYPE") == "PLANS") {
            } else

In case of Fragment, call the below method inside onDestoyView()-


You can implement OnConscentListener in your activity and then pass it as a reference.

To check if an article/content is free/paid or payment needs to be done, in your class, use as below sample: Parameters detail can be checked below for more information.


Call checkContentAccess method on override onNewIntent method in Activity Class.

Call the below function and pass the userId, after the user has logged in:


To use only the Subscription Landing Page, call the below method:

Create a singleton instance as done during initialization of the paywall.

Login Functionality

Call this method to invoke our Login System


Logout the User:


Demo App: Link

Last updated