Qonversion

https://documentation.qonversion.io/docs/
Admin
Qonversion is a comprehensive platform for managing in-app and web purchases, enabling developers to...
Tokens:165,118
Snippets:1,869
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Handle Installment Plans in Java

Source: https://documentation.qonversion.io/docs/android-8-migration-guide

Example demonstrating how to check for and retrieve installment plan details for a product using the Qonversion SDK in Java. This is useful when a customer commits to pay for several subsequent subscription periods.

```java
Qonversion.getSharedInstance().products(new QonversionProductsCallback() {
    @Override
    public void onSuccess(@NonNull Map<String, QProduct> products) {
      QProduct installmentProduct = products.get("installmentProductId");
      if (installmentProduct == null) {
        // Product not found
        return;
      }

      QProductStoreDetails storeDetails = installmentProduct.getStoreDetails();
      if (storeDetails != null && storeDetails.isInstallment()) {
        QProductOfferDetails basePlan = storeDetails.getBasePlanSubscriptionOfferDetails();
        if (basePlan == null) {
          // No base plans exist
          return;
        }
        QProductInstallmentPlanDetails installmentPlanDetails = basePlan.getInstallmentPlanDetails();
        // Use the installment plan information
      }
    }

    @Override
    public void onError(@NonNull QonversionError error) {
  		// Handle error here
    }
  });
```

--------------------------------

### Handle Installment Plans in Kotlin

Source: https://documentation.qonversion.io/docs/android-8-migration-guide

Example demonstrating how to check for and retrieve installment plan details for a product using the Qonversion SDK in Kotlin. This is useful when a customer commits to pay for several subsequent subscription periods.

```kotlin
Qonversion.shared.products(object : QonversionProductsCallback {
    override fun onSuccess(products: Map<String, QProduct>) {
      val installmentProduct = products["installmentProductId"]
      val storeDetails = installmentProduct?.storeDetails
      if (storeDetails?.isInstallment == true) {
        val installmentPlanDetails = storeDetails.basePlanSubscriptionOfferDetails?.installmentPlanDetails
        // Use the installment plan information
      }
    }

    override fun onError(error: QonversionError) {
  		// Handle error here
    }
  })
```

--------------------------------

### Install via CocoaPods

Source: https://documentation.qonversion.io/docs/ios-sdk-setup

Add the Qonversion dependency to your Podfile and run the installation command.

```text
pod 'Qonversion'
```

```bash
pod install
```

--------------------------------

### Install iOS Dependencies

Source: https://documentation.qonversion.io/docs/kids-mode-sdk

Run the install command in your project directory after updating the Podfile.

```text
pod install
```

--------------------------------

### Install via OpenUPM

Source: https://documentation.qonversion.io/docs/unity-sdk

Use the openupm-cli to add the Qonversion Unity package to your project.

```bash
openupm add com.qonversion.unity
```

--------------------------------

### Initiate Purchase across platforms

Source: https://documentation.qonversion.io/docs/glassfy-migration-guide

Use these examples to trigger a purchase flow for a Qonversion product and handle the resulting entitlement status.

```java
Qonversion.getSharedInstance().purchase(this, product, new QonversionPurchaseCallback() {
    @Override
    public void onResult(@NonNull QPurchaseResult result) {
        if (result.isSuccessful()) {
            QEntitlement premium = result.getEntitlements().get("premium");
            if (premium != null && premium.isActive()) {
                // Grant user access to premium features
            }
        } else if (result.isCanceledByUser()) {
            // Handle canceled purchase
        } else if (result.isPending()) {
            // Handle pending purchase
        } else {
            // Handle errors
        }
    }
});
```

```kotlin
Qonversion.shared.purchase(this, product, object : QonversionPurchaseCallback {
    override fun onResult(result: QPurchaseResult) {
        when {
            result.isSuccessful -> {
                val premium = result.entitlements["premium"]
                if (premium != null && premium.isActive) {
                    // Grant user access to premium features
                }
            }
            result.isCanceledByUser -> {
                // Handle canceled purchase
            }
            result.isPending -> {
                // Handle pending purchase
            }
            else -> {
                // Handle errors
            }
        }
    }
})
```

```dart
final result = await Qonversion.getSharedInstance().purchaseWithResult(product);

if (result.isSuccess) {
  final premium = result.entitlements?['premium'];
  if (premium != null && premium.isActive) {
    // Grant user access to premium features
  }
} else if (result.isCanceled) {
  // Handle canceled purchase
} else if (result.isPending) {
  // Handle pending purchase
} else {
  // Handle errors
}
```

```javascript
const result: PurchaseResult = await Qonversion.getSharedInstance().purchaseWithResult(product);

if (result.isSuccess) {
  const premium = result.entitlements?.get('premium');
  if (premium && premium.isActive) {
    // Grant user access to premium features
  }
} else if (result.isCanceled) {
  // Handle canceled purchase
} else if (result.isPending) {
  // Handle pending purchase
} else {
  // Handle errors
}
```

```csharp
Qonversion.GetSharedInstance().Purchase(product, (result) =>
{
    if (result.IsSuccess)
    {
        if (result.Entitlements != null && 
            result.Entitlements.TryGetValue("premium", out var premium) && 
            premium.IsActive)
        {
            // Grant user access to premium features
        }
    }
    else if (result.IsCanceled)
    {
        // Handle canceled purchase
    }
    else if (result.IsPending)
    {
        // Handle pending purchase
    }
    else
    {
        // Handle errors
    }
});
```

```typescript
const result = await Qonversion.getSharedInstance().purchase(product);

if (result.isSuccess) {
  const premium = result.entitlements?.get('premium');
  if (premium && premium.isActive) {
    // Grant user access to premium features
  }
} else if (result.isCanceled) {
  // Handle canceled purchase
} else if (result.isPending) {
  // Handle pending purchase
} else {
  // Handle errors
}
```

```typescript
const result = await Qonversion.getSharedInstance().purchase(product);

if (result.isSuccess) {
  const premium = result.entitlements?.get('premium');
  if (premium && premium.isActive) {
    // Grant user access to premium features
  }
} else if (result.isCanceled) {
  // Handle canceled purchase
} else if (result.isPending) {
  // Handle pending purchase
} else {
  // Handle errors
}
```

--------------------------------

### Accessing Installment Plan Details

Source: https://documentation.qonversion.io/docs/react-native-8-migration-guide

Example of how to check if a product has an installment plan and access its details using the Qonversion SDK. This is useful for handling subscriptions with installment payments.

```typescript
const products = await Qonversion.getSharedInstance().products();
const installmentProduct: Product = products['installmentProductId'];
const storeDetails = installmentProduct?.storeDetails;
if (storeDetails?.isInstallment) {
  const installmentDetails = storeDetails?.basePlanSubscriptionOfferDetails?.installmentPlanDetails;
  // Use the installment plan information
}
```

--------------------------------

### Install Qonversion Web SDK

Source: https://documentation.qonversion.io/docs/web-sdk

Use these commands to add the Qonversion Web SDK dependency to your project.

```shell
npm install @qonversion/web-sdk
```

```shell
yarn add @qonversion/web-sdk
```

--------------------------------

### Install via Git URL

Source: https://documentation.qonversion.io/docs/unity-sdk

Add the Qonversion Unity package dependency to your project's manifest.json file.

```json
"dependencies": {
    "com.qonversion.unity": "https://github.com/qonversion/unity-sdk.git#9.5.0"
}
```

--------------------------------

### Install via Carthage

Source: https://documentation.qonversion.io/docs/ios-sdk-setup

Specify the Qonversion repository in your Cartfile and update dependencies.

```text
github "qonversion/qonversion-ios-sdk"
```

```bash
carthage update
```

--------------------------------

### Check Entitlements with Qonversion

Source: https://documentation.qonversion.io/docs/migrating-from-revenuecat-to-qonversion

Examples of checking user entitlements using the Qonversion SDK.

```swift
Qonversion.shared().checkEntitlements { (entitlements, error) in
    if let error = error {
      // handle error
      return
    }

    if let premium: Qonversion.Entitlement = entitlements["premium"], premium.isActive {
      // unlock feature
    }
  }
```

```objectivec
[[Qonversion sharedInstance] checkEntitlements:^(NSDictionary<NSString *, QONEntitlement *> * _Nonnull entitlements,
                                  NSError * _Nullable error) {
      QONEntitlement *premiumEntitlement = entitlements[@"premium"];
      if (premiumEntitlement && premiumEntitlement.isActive) {
        // unlock feature
      }
  }];
```

```java
Qonversion.getSharedInstance().checkEntitlements(new QonversionEntitlementsCallback() {
      @Override
      public void onSuccess(@NotNull Map<String, QEntitlement> entitlements) {
          final QEntitlement premiumEntitlement = entitlements.get("premium");

          if (premiumEntitlement != null && premiumEntitlement.isActive()) {
              // unlock feature
          }
      }

      @Override
      public void onError(@NotNull QonversionError error) {
          // handle error here
      }
  });
```

```kotlin
Qonversion.shared.checkEntitlements(object: QonversionEntitlementsCallback {
      override fun onSuccess(entitlements: Map<String, QEntitlement>) {
          val premiumEntitlement = entitlements["premium"]
          if (premiumEntitlement != null && premiumEntitlement.isActive) {
              // unlock feature
          }
      }

      override fun onError(error: QonversionError) {
          // handle error here
      }
  })
```

```dart
try {
    final Map<String, QEntitlement> entitlements = await Qonversion.getSharedInstance().checkEntitlements();
    final premium = entitlements['premium'];
    if (premium != null && premium.isActive) {
      // unlock feature
    }
  } catch (e) {
    print(e);
  }
```

```typescript
try {
    const entitlements = await Qonversion.getSharedInstance().checkEntitlements();

    const premiumEntitlement = entitlements.get('premium');
    if (premiumEntitlement != null) {
      // unlock feature
    }
  } catch (e) {
    // handle error here
  }
```

```csharp
Qonversion.GetSharedInstance().CheckEntitlements((entitlements, error) =>
  {
      if (error == null)
      {
          if (entitlements.TryGetValue("premium", out Entitlement premium) && premium.IsActive)
          {
              // unlock feature
          }
      }
      else
      {
          // Handle the error
          Debug.Log("Error" + error.ToString());
      }
  });
```

--------------------------------

### Install Qonversion Capacitor Plugin

Source: https://documentation.qonversion.io/docs/capacitor

Use npm to add the Qonversion Capacitor plugin package to your project.

```bash
npm install @qonversion/capacitor-plugin
```

--------------------------------

### Nested Condition Logic Example

Source: https://documentation.qonversion.io/docs/conditional-logic

Demonstrates a nested logical expression using platform and OS version variables.

```text
(Platform equals iOS AND OS Version greater_or_equal 16.0)
OR
(Platform equals Android AND OS Version greater_or_equal 13.0)
```

--------------------------------

### Install Qonversion SDK via Gradle

Source: https://documentation.qonversion.io/docs/android-sdk

Add the Qonversion library dependency to your app's build.gradle file to integrate the SDK.

```groovy
dependencies {    
     implementation 'io.qonversion.android.sdk:sdk:9.+'
}
```

--------------------------------

### Initialize Qonversion Configuration

Source: https://documentation.qonversion.io/docs/web-sdk

Create a basic configuration object using the project key.

```javascript
import {QonversionConfigBuilder} from '@qonversion/web-sdk';

  ...

  const config = new QonversionConfigBuilder(projectKey).build();
```

--------------------------------

### Access Installment Plan Details

Source: https://documentation.qonversion.io/docs/cordova-6-migration-guide

Example of how to check for and access installment plan details for a product offer. This is useful when dealing with subscription offers that involve installment payments.

```typescript
const products = await Qonversion.getSharedInstance().products();
const installmentProduct = products['installmentProductId'];
const storeDetails = installmentProduct?.storeDetails;
if (storeDetails?.isInstallment) {
  const installmentDetails = storeDetails?.basePlanSubscriptionOfferDetails?.installmentPlanDetails;
  // Use the installment plan information
}
```

--------------------------------

### Access Installment Plan Details in Unity

Source: https://documentation.qonversion.io/docs/unity-8-migration-guide

Example of how to check for and access installment plan details for a product offer in the Unity SDK. This is useful when Google Play introduces new subscription models.

```csharp
Qonversion.GetSharedInstance().Products((products, error) => {
    var installmentProduct = products["android_installment"];
    var storeDetails = installmentProduct?.StoreDetails;
    if (storeDetails?.IsInstallment == true) {
      var installmentPlanDetails = storeDetails.BasePlanSubscriptionOfferDetails?.InstallmentPlanDetails;
      // Use the installment plan information
    }
  });
```

--------------------------------

### Initialize Qonversion SDK

Source: https://documentation.qonversion.io/docs/unity-4-migration-guide

Compare the legacy static initialization with the new instance-based configuration pattern.

```csharp
Qonversion.Launch("projectKey", true);
```

```csharp
QonversionConfig config = new QonversionConfigBuilder(
        "projectKey",
        LaunchMode.SubscriptionManagement
    ).Build();
Qonversion.Initialize(config);
```

--------------------------------

### Initialize Qonversion SDK (Version 3.+)

Source: https://documentation.qonversion.io/docs/ios-3-migration-guide

The current method requires creating a configuration object with a specific launch mode before initialization.

```swift
let configuration = Qonversion.Configuration(projectKey: "projectKey", launchMode: .subscriptionManagement)
Qonversion.initWithConfig(configuration)
```

```objectivec
QONConfiguration *configuration = [[QONConfiguration alloc] initWithProjectKey:@"projectKey" launchMode:QONLaunchModeSubscriptionManagement];
[Qonversion initWithConfig:configuration];
```

--------------------------------

### Get Promotional Offer in React Native

Source: https://documentation.qonversion.io/docs/apple-promotional-offers

This React Native TypeScript example shows how to retrieve a promotional offer. It finds the relevant discount and handles errors using a try-catch block.

```typescript
try {
    // You can obtain the product and discount in any other way. This approach is used here as an example.
    const promo = subscriptionProduct.skProduct?.discounts?.find(discount =>
        discount.identifier === 'my_promo_offer_id'
    );
    
    if (promo) {
      const promoOffer = await Qonversion.getSharedInstance().getPromotionalOffer(subscriptionProduct, promo);
    }
    // handle promo offer here
  } catch (e) {
      // handle error here
  }
```

--------------------------------

### products()

Source: https://documentation.qonversion.io/docs/displaying-products

Fetches all products configured for the project. Returns a dictionary where keys are Qonversion Product IDs and values are Qonversion.Product objects.

```APIDOC
## products()

### Description
Fetches every product configured for your project. The method returns a dictionary keyed by Qonversion Product ID; each value is a Qonversion.Product object.

### Returns
- **productsList** (Map<String, QProduct>) - A dictionary of available products.
- **error** (QonversionError) - The error object if the request failed.
```

--------------------------------

### Send Tenjin Installation ID to Qonversion

Source: https://documentation.qonversion.io/docs/tenjin

Retrieve the Tenjin installation ID using the Tenjin SDK and set it as a user property in Qonversion. Ensure the Tenjin SDK is installed and Qonversion SDK is set up.

```swift
let tenjinId = TenjinSDK.getAnalyticsInstallationId()
Qonversion.shared().setUserProperty(.tenjinAnalyticsInstallationId, value: tenjinId)
```

```objectivec
[[Qonversion sharedInstance] setUserProperty:QONUserPropertyKeyTenjinAnalyticsInstallationId value:[TenjinSDK getAnalyticsInstallationId]];
```

```java
TenjinSDK instance = TenjinSDK.getInstance(this, "<SDK_KEY>");
String analyticsId = instance.getAnalyticsInstallationId();

Qonversion.getSharedInstance().setUserProperty(QUserPropertyKey.TenjinAnalyticsInstallationId, analyticsId);
```

```kotlin
val instance = TenjinSDK.getInstance(this, "<SDK_KEY>")
val analyticsId = instance.analyticsInstallationId

Qonversion.shared.setUserProperty(QUserPropertyKey.TenjinAnalyticsInstallationId, analyticsId)
```

```dart
String? analyticsId = await TenjinSDK.instance.getAnalyticsInstallationId();

if (analyticsId != null) {
    Qonversion.getSharedInstance().setUserProperty(QUserPropertyKey.tenjinAnalyticsInstallationId, analyticsId);
}
```

```typescript
const analyticsId = await Tenjin.getAnalyticsInstallationId()

Qonversion.getSharedInstance().setUserProperty(UserPropertyKey.TENJIN_ANALYTICS_INSTALLATION_ID, analyticsId);
```

```csharp
BaseTenjin instance = Tenjin.getInstance("<SDK_KEY>");
analyticsId = instance.GetAnalyticsInstallationId;

Qonversion.GetSharedInstance().SetUserProperty(UserPropertyKey.TenjinAnalyticsInstallationId, analyticsId);
```

```typescript
Qonversion.getSharedInstance().setUserProperty(Qonversion.UserPropertyKey.TENJIN_ANALYTICS_INSTALLATION_ID, "tenjinAiid");
```

```typescript
const analyticsId = await Tenjin.getAnalyticsInstallationId();

Qonversion.getSharedInstance().setUserProperty(UserPropertyKey.TENJIN_ANALYTICS_INSTALLATION_ID, analyticsId);
```

--------------------------------

### Initialize the SDK Instance

Source: https://documentation.qonversion.io/docs/web-sdk

Initialize the Qonversion SDK using the prepared configuration object.

```javascript
import Qonversion from '@qonversion/web-sdk';

  ...

  const qonversionInstance = Qonversion.initialize(config);
```

--------------------------------

### Install Capacitor Plugin

Source: https://documentation.qonversion.io/docs/installation

Install the plugin via npm or Yarn and update iOS pods.

```bash
npm install @qonversion/capacitor-plugin --save
```

```bash
yarn add @qonversion/capacitor-plugin
```

```bash
cd ios && pod install
```

--------------------------------

### Install Cordova Plugin

Source: https://documentation.qonversion.io/docs/installation

Install the plugin via npm or Yarn and update iOS pods.

```bash
npm install @qonversion/cordova-plugin --save
```

```bash
yarn add @qonversion/cordova-plugin
```

```bash
cd ios && pod install
```

--------------------------------

### Braze Event Payload Example

Source: https://documentation.qonversion.io/docs/braze

Example of the JSON structure for events sent from Qonversion to Braze.

```json
{
   "events":[
      {
         "external_id":"638e041drd467600318edd46",
         "name":"subscription_renewed",
         "properties":{
            "revenue":99,
            "storefront":"USA"
         },
         "time":"2023-06-14T12:20:36+00:00"
      }
   ]
}
```

--------------------------------

### Initiate a Purchase

Source: https://documentation.qonversion.io/docs/making-purchases

Use the purchase method to start a transaction and handle the resulting entitlement status. Ensure products are configured in the Qonversion dashboard before implementation.

```swift
Qonversion.shared().purchase(product) { (result) in
    if result.isSuccessful {
      if let premium: Qonversion.Entitlement = result.entitlements["premium"], premium.isActive {
        // Grant user access to premium features
      }
    } else if result.isCanceledByUser {
      // Handle canceled purchase
    } else if result.isPending {
      // Handle pending purchase
    } else {
      // Handle errors
    }
  }
```

```objectivec
[[Qonversion sharedInstance] purchaseWithResult:product completion:^(QONPurchaseResult * _Nonnull result) {
    if (result.isSuccessful) {
      QONEntitlement *premiumEntitlement = result.entitlements[@"premium"];
      if (premiumEntitlement && premiumEntitlement.isActive) {
        // Grant user access to premium features
      }
    } else if (result.isCanceledByUser) {
      // Handle canceled purchase
    } else if (result.isPending) {
      // Handle pending purchase
    } else {
      // Handle errors
    }
  }];
```

```java
Qonversion.getSharedInstance().purchase(this, product, new QonversionPurchaseCallback() {
      @Override
      public void onResult(@NonNull QPurchaseResult result) {
          if (result.isSuccessful()) {
              QEntitlement premium = result.getEntitlements().get("premium");
              if (premium != null && premium.isActive()) {
                  // Grant user access to premium features
              }
          } else if (result.isCanceledByUser()) {
              // Handle canceled purchase
          } else if (result.isPending()) {
              // Handle pending purchase
          } else {
              // Handle errors
          }
      }
  });
```

```kotlin
Qonversion.shared.purchase(requireActivity(), product, object : QonversionPurchaseCallback {
      override fun onResult(result: QPurchaseResult) {
          when {
              result.isSuccessful -> {
                  val premium = result.entitlements["premium"]
                  if (premium != null && premium.isActive) {
                      // Grant user access to premium features
                  }
              }
              result.isCanceledByUser -> {
                  // Handle canceled purchase
              }
              result.isPending -> {
                  // Handle pending purchase
              }
              else -> {
                  // Handle errors
              }
          }
      }
  })
```

```dart
final result = await Qonversion.getSharedInstance().purchaseWithResult(product);

  if (result.isSuccess) {
    final premium = result.entitlements?['premium'];
    if (premium != null && premium.isActive) {
      // Grant user access to premium features
    }
  } else if (result.isCanceled) {
    // Handle canceled purchase
  } else if (result.isPending) {
    // Handle pending purchase
  } else {
    // Handle errors
  }
```

```typescript
const result: PurchaseResult = await Qonversion.getSharedInstance().purchaseWithResult(product);

  if (result.isSuccess) {
    const premium = result.entitlements?.get('premium');
    if (premium && premium.isActive) {
      // Grant user access to premium features
    }
  } else if (result.isCanceled) {
    // Handle canceled purchase
  } else if (result.isPending) {
    // Handle pending purchase
  } else {
    // Handle errors
  }
```

--------------------------------

### Install React Native SDK

Source: https://documentation.qonversion.io/docs/installation

Install the SDK via npm or Yarn and update iOS pods.

```bash
npm install @qonversion/react-native-sdk --save
```

```bash
yarn add @qonversion/react-native-sdk
```

```bash
cd ios && pod install
```

--------------------------------

### Conditional Rule Priority Example

Source: https://documentation.qonversion.io/docs/conditional-logic

An example demonstrating how rules are evaluated from top to bottom, where the first matching condition takes precedence.

```text
Rule 1: Platform = iOS AND Theme = dark    -> white text, large font
Rule 2: Platform = iOS                     -> dark text, large font
Rule 3: (default — no conditions match)    -> keeps default styles
```

--------------------------------

### Initialize No-Codes SDK

Source: https://documentation.qonversion.io/docs/displaying-no-codes

Initialize the SDK using the project key provided by Qonversion.

```swift
// You can initialize using only project key
let configuration = NoCodesConfiguration(projectKey: "projectKey")
NoCodes.initialize(with: configuration)
```

```kotlin
// You can initialize using only project key
val noCodesConfig = NoCodesConfig.Builder(this, "projectKey").build()
NoCodes.initialize(noCodesConfig)
```

```java
// You can initialize using only project key
final NoCodesConfig noCodesConfig = new NoCodesConfig.Builder(this, "projectKey").build();
NoCodes.initialize(noCodesConfig);
```

```typescript
// You can initialize using only project key
const noCodesConfig = new NoCodesConfigBuilder('projectKey')
  .build();
NoCodes.initialize(noCodesConfig);
```

```dart
// You can initialize using only project key
final noCodesConfig = new NoCodesConfigBuilder(projectKey).build();
NoCodes.initialize(noCodesConfig);
```

```csharp
// You can initialize using only project key
var noCodesConfig = new NoCodesConfigBuilder("projectKey")
    .Build();
NoCodes.Initialize(noCodesConfig);
```

```typescript
// You can initialize using only project key
const noCodesConfig = new Qonversion.NoCodesConfigBuilder('projectKey')
  .build();
Qonversion.NoCodes.initialize(noCodesConfig);
```

```typescript
// You can initialize using only project key
const noCodesConfig = new NoCodesConfigBuilder('projectKey')
  .build();
NoCodes.initialize(noCodesConfig);
```

--------------------------------

### Qonversion.initialize

Source: https://documentation.qonversion.io/docs/web-sdk

Initializes the Qonversion SDK with a configuration object.

```APIDOC
## Qonversion.initialize

### Description
Initializes the SDK using the provided configuration.

### Usage
```javascript
import Qonversion from '@qonversion/web-sdk';
const qonversionInstance = Qonversion.initialize(config);
```
```

--------------------------------

### Access Installment Plan Details

Source: https://documentation.qonversion.io/docs/flutter-9-migration-guide

Check if a product has an installment plan and retrieve its details. This code snippet demonstrates how to access `isInstallment` and `installmentPlanDetails` from `QProductStoreDetails`.

```dart
var products = await Qonversion.getSharedInstance().products();
var installmentProduct = products["installmentProductId"];
var storeDetails = installmentProduct?.storeDetails;
if (storeDetails?.isInstallment == true) {
  var installmentPlanDetails = storeDetails?.basePlanSubscriptionOfferDetails?.installmentPlanDetails;
  // Use the installment plan information
}
```

--------------------------------

### Get Promotional Offer in Flutter

Source: https://documentation.qonversion.io/docs/apple-promotional-offers

Use this Dart code within a Flutter application to get a promotional offer. It finds the discount by its identifier and handles potential exceptions.

```dart
try {
    // You can obtain the product and discount in any other way. This approach is used here as an example.
    var promo = subscriptionProduct.skProduct?.discounts?.firstWhereOrNull(
      (discount) => discount.identifier == 'my_promo_offer_id'
    );

    if (promo != null) {
      var promoOffer = await Qonversion.getSharedInstance().getPromotionalOffer(subscriptionProduct, promo);
      // handle promo offer here
    }
  } on Exception catch (e) {
    // handle error here
  }
```

--------------------------------

### Initialize Qonversion SDK (Legacy)

Source: https://documentation.qonversion.io/docs/ios-3-migration-guide

The previous method used for initializing the Qonversion SDK.

```swift
Qonversion.launch(withKey: "projectKey")
```

```objectivec
[Qonversion launchWithKey:@"projectKey"];
```

--------------------------------

### Complete Purchase (Unity)

Source: https://documentation.qonversion.io/docs/app-store-promoted-purchases

Call `startPromoPurchase` in Unity to initialize the purchase, for example, immediately after onboarding screens. Handle the purchase result, including active entitlements or errors.

```csharp
startPromoPurchase((entitlements, error) =>
{
    if (error == null)
    {
        if (entitlements.TryGetValue("premium", out Entitlement premium) && premium.IsActive)
        {
            // Handle the active entitlement here
        }
    }
    else
    {
        // Handle the error  
        Debug.Log("Error" + error.ToString());
    }
});
```

--------------------------------

### OneSignal Event Payload Example

Source: https://documentation.qonversion.io/docs/onesignal

Qonversion uses the 'q_status' tag to add data attributes to OneSignal users, corresponding to event names. This JSON shows an example payload for a 'trial_converted' status.

```json
{
   "tags":{
      "q_status":"trial_converted"
   }
}
```

--------------------------------

### userInfo()

Source: https://documentation.qonversion.io/docs/user-identifiers

Retrieves the current Qonversion User ID associated with the installation.

```APIDOC
## userInfo()

### Description
Retrieves the unique Qonversion User ID created for the app installation. This identifier can be used for third-party integrations or matching data from webhook notifications.

### Method
SDK Method

### Parameters
- **callback** (Function/Closure) - Required - A callback function to handle the returned user object or potential errors.
```

--------------------------------

### Initialize Qonversion SDK

Source: https://documentation.qonversion.io/docs/installation

Initialize the SDK using the project key obtained from the Qonversion dashboard. This configuration connects the application to the project for screen rendering and metric tracking.

```swift
// You can initialize using only project key
let configuration = NoCodesConfiguration(projectKey: "projectKey")
NoCodes.initialize(with: configuration)
```

```kotlin
// You can initialize using only project key
val noCodesConfig = NoCodesConfig.Builder(this, "projectKey").build()
NoCodes.initialize(noCodesConfig)
```

```java
// You can initialize using only project key
final NoCodesConfig noCodesConfig = new NoCodesConfig.Builder(this, "projectKey").build();
NoCodes.initialize(noCodesConfig);
```

```typescript
// You can initialize using only project key
const noCodesConfig = new NoCodesConfigBuilder('projectKey')
  .build();
NoCodes.initialize(noCodesConfig);
```

```dart
final noCodesConfig = new NoCodesConfigBuilder(projectKey).build();
NoCodes.initialize(noCodesConfig);
```

```typescript
// You can initialize using only project key
const noCodesConfig = new Qonversion.NoCodesConfigBuilder('projectKey')
  .build();
Qonversion.NoCodes.initialize(noCodesConfig);
```

```typescript
// You can initialize using only project key
const noCodesConfig = new NoCodesConfigBuilder('projectKey')
  .build();
NoCodes.initialize(noCodesConfig);
```

--------------------------------

### Initialize Qonversion SDK

Source: https://documentation.qonversion.io/docs/glassfy-migration-guide

Initialization patterns for the Qonversion SDK across different platforms.

```swift
import Qonversion

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let config = Qonversion.Configuration(projectKey: "projectKey", launchMode: .subscriptionManagement)
    Qonversion.initWithConfig(config)
  	return true
}
```

```objectivec
#import "Qonversion.h"
  
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    QONConfiguration *configuration = [[QONConfiguration alloc] initWithProjectKey:@"projectKey" launchMode:QONLaunchModeSubscriptionManagement];
    [Qonversion initWithConfig:configuration];
    
    return YES;
}
```

```java
import com.qonversion.android.sdk.Qonversion;
import com.qonversion.android.sdk.QonversionConfig;
import com.qonversion.android.sdk.dto.QLaunchMode;

public class App extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        final QonversionConfig qonversionConfig = new QonversionConfig.Builder(
                this,
                "projectKey",
                QLaunchMode.SubscriptionManagement
        ).build();
        Qonversion.initialize(qonversionConfig);
    }
}
```

```kotlin
import com.qonversion.android.sdk.Qonversion
import com.qonversion.android.sdk.QonversionConfig
import com.qonversion.android.sdk.dto.QLaunchMode

public class App : Application {
    override fun onCreate() {
        super.onCreate()
        val qonversionConfig = QonversionConfig.Builder(
            this,
            "projectKey",
            QLaunchMode.SubscriptionManagement
        ).build()
        Qonversion.initialize(qonversionConfig)
    }
}
```

```dart
import 'package:qonversion_flutter/qonversion_flutter.dart';

final config = new QonversionConfigBuilder(
  'projectKey',
  QLaunchMode.subscriptionManagement
).build();
Qonversion.initialize(config);
```

```javascript
import Qonversion, {
  QonversionConfigBuilder,
  LaunchMode,
} from 'react-native-qonversion';

const config = new QonversionConfigBuilder(
  'projectKey',
  LaunchMode.SUBSCRIPTION_MANAGEMENT
).build();
Qonversion.initialize(config);
```

```csharp
using QonversionUnity;

private void Start()
{
    QonversionConfig config = new QonversionConfigBuilder(
            "projectKey",
            LaunchMode.SubscriptionManagement
        ).Build();
    Qonversion.Initialize(config);
}
```

```typescript
const config = new Qonversion.ConfigBuilder(
  'projectKey',
  Qonversion.LaunchMode.SUBSCRIPTION_MANAGEMENT,
).build();
Qonversion.initialize(config);
```

```typescript
import Qonversion, {
  QonversionConfigBuilder,
  LaunchMode,
} from '@qonversion/capacitor-plugin';

const config = new QonversionConfigBuilder(
  'projectKey',
  LaunchMode.SUBSCRIPTION_MANAGEMENT
).build();
Qonversion.initialize(config);
```

--------------------------------

### Access Qonversion Instance

Source: https://documentation.qonversion.io/docs/android-4-migration-guide

Access the initialized Qonversion instance after setup.

```kotlin
Qonversion.shared
```

```java
Qonversion.getSharedInstance();
```

--------------------------------

### Initialize Qonversion with Configuration

Source: https://documentation.qonversion.io/docs/ios-3-migration-guide

Configure the Qonversion SDK during initialization using the updated entitlement-based methods.

```swift
let configuration = Qonversion.Configuration(projectKey: "projectKey", launchMode: .subscriptionManagement)
configuration.setEntitlementsUpdateListener(self)
Qonversion.initWithConfig(config)
```

```objectivec
QONConfiguration *configuration = [[QONConfiguration alloc] initWithProjectKey:@"projectKey" launchMode:QONLaunchModeSubscriptionManagement];
[configuration setEntitlementsCacheLifetime:QONEntitlementsCacheLifetimeThreeMonths];
[Qonversion initWithConfig:configuration];
```

--------------------------------

### Install Flutter dependencies

Source: https://documentation.qonversion.io/docs/flutter-sdk

Run this command in your terminal to fetch the added dependencies.

```bash
flutter pub get
```

--------------------------------

### Initialize Qonversion SDK

Source: https://documentation.qonversion.io/docs/flutter-5-migration-guide

The legacy launch method is replaced by a configuration builder pattern. Use QonversionConfigBuilder to define your launch mode and initialize the instance.

```dart
Qonversion.launch('projectKey', isObserveMode: true);
```

```dart
final config = new QonversionConfigBuilder(
  'projectKey',
  QLaunchMode.subscriptionManagement
).build();
Qonversion.initialize(config);
```

--------------------------------

### Handle Action Execution Start

Source: https://documentation.qonversion.io/docs/displaying-no-codes

Notifies when the execution of a dashboard-configured action has begun.

```swift
func noCodesStartsExecuting(action: NoCodesAction)
```

```kotlin
fun onActionStartedExecuting(action: QAction)
```

```java
void onActionStartedExecuting(QAction action)
```

```typescript
onActionStartedExecuting: (action: NoCodesAction) => {}
```

```dart
_actionStartedStream = NoCodes.getSharedInstance().actionStartedStream.listen((event) {
    // add functionality here
});
```

```csharp
void OnActionStarted(NoCodesAction action)
```

```typescript
onActionStartedExecuting: (action: Qonversion.NoCodesAction) => {}
```

```typescript
onActionStartedExecuting: (action: NoCodesAction) => {}
```

--------------------------------

### Load products with Qonversion

Source: https://documentation.qonversion.io/docs/swiftystorekit-alternative

Fetches products configured in the Qonversion dashboard.

```swift
Qonversion.shared().products { productsList, error in
    let product = productsList["main"]
    if product?.type == .trial {
    
    }
}
```

```objectivec
[[Qonversion sharedInstance] products:^(NSDictionary<NSString *,QONProduct *> * _Nonnull productsList, NSError * _Nullable error) {
    if (error) {
      // Handle error
    }
    QONProduct *product = productsList[@"main"];
    if (product && product.type == QONProductTypeTrial) {

    }
}];
```

--------------------------------

### Purchase with Promotional Offer in Objective-C

Source: https://documentation.qonversion.io/docs/apple-promotional-offers

This Objective-C code demonstrates how to initiate a purchase with a promotional offer. It requires a promotionalOffer object and the product details.

```objectivec
QONPurchaseOptions *purchaseOptions = [[QONPurchaseOptions alloc] initWithPromoOffer:promotionalOffer];
[[Qonversion sharedInstance] purchaseWithResult:product
                                          options:purchaseOptions
                                       completion:^(QONPurchaseResult * _Nonnull result) {
    // handle purchase result here
  }];
```

--------------------------------

### Install Android SDK

Source: https://documentation.qonversion.io/docs/installation

Add the No-Codes SDK dependency to your package-level build.gradle file.

```groovy
implementation 'io.qonversion:no-codes:1.+'
```

--------------------------------

### Initialize Qonversion SDK in Sandbox Mode (Java)

Source: https://documentation.qonversion.io/docs/testing

Use this snippet to initialize the Qonversion SDK in sandbox mode for testing purposes. Ensure you replace 'projectKey' with your actual project key.

```java
final QonversionConfig qonversionConfig = new QonversionConfig.Builder(
        this,
        "projectKey",
        QLaunchMode.SubscriptionManagement
)
        .setEnvironment(QEnvironment.Sandbox)
        .build();
Qonversion.initialize(qonversionConfig);
```

--------------------------------

### Initialize No-Code with a specific theme

Source: https://documentation.qonversion.io/docs/displaying-no-codes

Configure the theme mode during the initial setup of the No-Code SDK.

```swift
var config = NoCodesConfiguration(
    projectKey: "your_project_key",
    theme: .dark
)
NoCodes.initialize(with: config)
```

```kotlin
val config = NoCodesConfig.Builder(context, "your_project_key")
    .setTheme(NoCodesTheme.Dark)
    .build()
NoCodes.initialize(config)
```

```java
NoCodesConfig config = new NoCodesConfig.Builder(context, "your_project_key")
    .setTheme(NoCodesTheme.Dark)
    .build();
NoCodes.initialize(config);
```

```typescript
const noCodesConfig = new NoCodesConfigBuilder("projectKey")
    .setTheme(NoCodesTheme.DARK)
    .build();
NoCodes.initialize(noCodesConfig);
```

```dart
final noCodesConfig = NoCodesConfigBuilder("projectKey")
    .setTheme(NoCodesTheme.dark)
    .build();
NoCodes.initialize(noCodesConfig);
```

```csharp
var noCodesConfig = new NoCodesConfigBuilder("projectKey")
    .SetTheme(NoCodesTheme.Dark)
    .Build();
NoCodes.Initialize(noCodesConfig);
```

```typescript
const noCodesConfig = new Qonversion.NoCodesConfigBuilder("projectKey")
    .setTheme(Qonversion.NoCodesTheme.DARK)
    .build();
Qonversion.NoCodes.initialize(noCodesConfig);
```

```typescript
const noCodesConfig = new NoCodesConfigBuilder("projectKey")
    .setTheme(NoCodesTheme.DARK)
    .build();
NoCodes.initialize(noCodesConfig);
```

--------------------------------

### Initialize Qonversion SDK in Sandbox Mode (Unity)

Source: https://documentation.qonversion.io/docs/testing

Use this snippet to initialize the Qonversion SDK in sandbox mode for testing purposes. Ensure you replace 'projectKey' with your actual project key.

```csharp
QonversionConfig config = new QonversionConfigBuilder(
          "projectKey",
          LaunchMode.SubscriptionManagement
      )
      .SetEnvironment(Environment.Sandbox)
      .Build();
Qonversion.Initialize(config);
```
Tokens:
Raw