Purchasely

https://docs.purchasely.com/docs/
Admin
Purchasely is a SaaS platform empowering subscription apps by streamlining in-app purchase...
Tokens:253,347
Snippets:2,258
Trust Score:8.8
Update:7 months ago
Show doc for...
Tokens:
Raw
### Install Cordova Plugin

Source: https://docs.purchasely.com/docs/general-cordova

Installs the main Purchasely Cordova plugin using NPM. This is the primary step for integrating the SDK into a Cordova project.

```shell
cordova plugin add @purchasely/cordova-plugin-purchasely
```

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

### Custom Screen Implementation Examples (SwiftUI/UIKit/Kotlin)

Source: https://docs.purchasely.com/docs/byos-implementation

Provides concrete examples of how to implement the custom screen delegates and providers. The Swift examples show how to return specific SwiftUI Views or UIKit ViewControllers based on the `presentation.id`. The Kotlin example demonstrates returning a custom Android View or Fragment.

```swift
// SwiftUI

public class CustomScreenViewDelegate: PLYCustomScreenViewDelegate {
    
    @ViewBuilder public func view(for presentation: PLYPresentation) -> some View {
        switch presentation.id {
        case "login":
            VStack {
                Spacer()
                Text("Hello Purchasely!")
                Spacer()
                Button(action: {
                }, label: {
                    Text("Login")
                        .font(.largeTitle)
                        .padding()
                })
            }
        default:
            EmptyView()
        }
    }
}


// UIKit
public class MyCustomScreenViewControllerDelegate: PLYCustomScreenViewControllerDelegate {
    public func viewController(for presentation: PLYPresentation) -> UIViewController? {
        switch presentation.id {
        case "login":
            LoginViewController()
        default:
            nil
        }
    }
}
```

```kotlin
class CustomScreenProvider(private val context: Context) : PLYCustomScreenProvider {

    override fun onCustomScreenRequested(presentation: PLYPresentation): PLYCustomScreen? {
        return when(presentation.id) {
            "login" -> {
                // Custom Login View

```

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

### Install Purchasely React Native SDK

Source: https://docs.purchasely.com/docs/general-react-native

Installs the main Purchasely React Native SDK using NPM. This is the primary step to integrate Purchasely into your React Native application.

```shell
npm install react-native-purchasely --save
```

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

### Start Purchasely SDK in Unity (C#)

Source: https://docs.purchasely.com/docs/sdk-initialization

Initializes the Purchasely SDK for Unity projects using C#. This setup should be performed early in the game's lifecycle. It requires specifying a user ID, StoreKit version, log level, running mode, and callback functions. Requires the Purchasely Unity SDK.

```csharp
private PurchaselyRuntime.Purchasely _purchasely;

_purchasely = new PurchaselyRuntime.Purchasely("USER_ID",
			false, // true for StoreKit 1, false for StoreKit 2
			LogLevel.Debug,
			RunningMode.Full,
			OnPurchaselyStart,
			OnPurchaselyEvent);

```

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

### Full ACTIVATE Event Payload Example (JSON)

Source: https://docs.purchasely.com/docs/backend-entitlements

This is a comprehensive example of the ACTIVATE event payload, including all available fields. It provides detailed information about the purchase, user, device, and environment, which can be useful for advanced analytics or debugging.

```json
{
  "plan": "monthly",
  "store": "GOOGLE_PLAY_STORE",
  "product": "PURCHASELY_PLUS",
  "user_id": "toto",
  "event_id": "5e45109f-7fac-45f8-a7e4-464892d5d35d",
  "event_name": "ACTIVATE",
  "offer_type": "NONE",
  "api_version": 3,
  "device_type": "PHONE",
  "environment": "SANDBOX",
  "purchased_at": "2023-12-12T14:13:11.777Z",
  "purchase_type": "RENEWING_SUBSCRIPTION",
  "store_country": "FR",
  "next_renewal_at": "2023-12-12T14:23:11.777Z",
  "purchased_at_ms": 1702390391777,
  "event_created_at": "2023-12-12T14:19:26.120Z",
  "is_family_shared": false,
  "store_product_id": "com.purchasely.plus.monthly",
  "customer_currency": "EUR",
  "plan_price_in_eur": 9.99,
  "next_renewal_at_ms": 1702390991777,
  "event_created_at_ms": 1702390766120,
  "previous_offer_type": "NONE",
  "store_app_bundle_id": "com.purchasely.demo",
  "subscription_status": "AUTO_RENEWING",
  "store_transaction_id": "GPA.3355-5688-7970-28037..5",
  "original_purchased_at": "2023-12-12T13:48:16.233Z",
  "original_purchased_at_ms": 1702388896233,
  "cumulated_revenues_in_eur": 69.9,
  "effective_next_renewal_at": "2023-12-12T14:23:11.777Z",
  "purchasely_subscription_id": "subs_D7GnVQbUxvY6YxoeK6nhyPDkmyCVcfe",
  "effective_next_renewal_at_ms": 1702390991777,
  "store_original_transaction_id": "GPA.3355-5688-7970-28037",
  "plan_price_in_customer_currency": 9.99
}
```

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

### Install Purchasely SDK for Unity (Maven)

Source: https://docs.purchasely.com/docs/general-sdk-installation

This XML snippet shows how to declare the Purchasely SDK for Unity as a dependency using Maven coordinates. It specifies a version range for compatibility.

```xml
<dependency>
  <groupId>io.purchasely</groupId>
  <artifactId>unity</artifactId>
  <version>[4.0,4.999]</version>
</dependency>
```

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

### Start Purchasely SDK with User ID (Kotlin)

Source: https://docs.purchasely.com/docs/sdk-implementation

Shows how to start the Purchasely SDK with an existing user ID if the user is already signed in. This is useful for initializing the SDK with pre-authenticated user data.

```kotlin
Purchasely.start(context, "YOUR_API_KEY", userId = "user_id")
```

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

### Start Purchasely SDK - Flutter

Source: https://docs.purchasely.com/docs/general-sdk-initialization

Initializes the Purchasely SDK for Flutter applications. The `start` method requires an apiKey and can optionally include logLevel and userId. The function returns a boolean indicating successful configuration. Ensure to handle the case where configuration fails.

```typescript
// Everything is optional except apiKey and storeKit1
// Example with default values
bool configured = await Purchasely.start(
        apiKey: '00000000-1111-2222-3333-444444444444',
        logLevel: PLYLogLevel.error, // set to debug in development mode to see logs
        userId: null, // set a user id if you have one
      );
    
if (!configured) {
        print('Purchasely SDK not configured');
        return;
}

```

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

### Fetch and Display Presentation in Kotlin

Source: https://docs.purchasely.com/docs/pre-fetching

Provides a Kotlin example for fetching a presentation using `Purchasely.fetchPresentation` with a placement ID. It includes error handling and logic to display the presentation or build a custom view based on the presentation type. The example also shows how to handle purchase results when the presentation is closed.

```kotlin
Purchasely.fetchPresentation(placementId = "onboarding") { presentation, error ->
  if(error != null) {
    Log.d("Purchasely", "Error fetching Screen", error)
    return@fetchPresentation
  }

  when(presentation?.type) {
    PLYPresentationType.NORMAL,
    PLYPresentationType.FALLBACK -> {
      
			// Easy: just call display
  			presentation?.display()
      
      // Intermediate: build the view to display it yourself in your layout for specific use cases
			// Note: this won't work with Flows
      val screenView = presentation.buildView(
        context = this@MainActivity,
        properties = PLYPresentationProperties(
          onClose = {
            // TODO remove view from your layout
          }
        )
      ) { result, plan ->
        // Screen is closed, check result to know if a purchase happened
        when(result) {
          PLYProductViewResult.PURCHASED -> Log.d("Purchasely", "User purchased ${plan?.name}")
          PLYProductViewResult.CANCELLED -> Log.d("Purchasely", "User cancelled purchased")

```

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

### Implement PLYPlayerInterface with Kotlin ExoPlayer

Source: https://docs.purchasely.com/docs/display-video-on-android

This snippet demonstrates implementing the PLYPlayerInterface using Kotlin and the ExoPlayer library. It covers setting up the player, loading media, configuring aspect ratio, and managing playback states. Key dependencies include the ExoPlayer library.

```kotlin
class PurchaselyPlayerView(context: Context) : PlayerView(context), PLYPlayerInterface {
  private var exoPlayer: SimpleExoPlayer = SimpleExoPlayer.Builder(context).build()

  override fun setup(url: String, contentMode: String, isMuted: Boolean) {
      val mediaItem = MediaItem.fromUri(Uri.parse(url))
      exoPlayer.addMediaItem(mediaItem)
      exoPlayer.playWhenReady = false
      exoPlayer.prepare()

      resizeMode = when (contentMode) {
          "fill" -> AspectRatioFrameLayout.RESIZE_MODE_ZOOM
          "fit" -> AspectRatioFrameLayout.RESIZE_MODE_FIT
          else -> AspectRatioFrameLayout.RESIZE_MODE_ZOOM
      }

      player = exoPlayer
      controllerAutoShow = false

      if (isMuted) {
          exoPlayer.volume = 0f
      } else {
          exoPlayer.volume = 1f
      }

      exoPlayer.repeatMode = Player.REPEAT_MODE_ALL
      hideController()
  }

  override fun play() {
      exoPlayer.play()
  }

  override fun pause() {
      exoPlayer.pause()
  }

  override fun release() {
      exoPlayer.release()
  }
}
```

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

### Install Amazon In-App Purchases Dependency

Source: https://docs.purchasely.com/docs/installation-react-native

Installs the NPM dependency required to integrate Amazon In-App Purchases with the Purchasely SDK. This package enables in-app purchases through the Amazon Appstore.

```shell
npm install @purchasely/react-native-purchasely-amazon --save
```

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

### Install Huawei Mobile Services Dependency

Source: https://docs.purchasely.com/docs/installation-react-native

Installs the NPM dependency required to integrate Huawei Mobile Services with the Purchasely SDK. This package enables in-app purchases through the Huawei AppGallery.

```shell
npm install @purchasely/react-native-purchasely-huawei --save
```

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

### Handle Purchases and Restores with RevenueCat (JavaScript)

Source: https://docs.purchasely.com/docs/process-transactions-with-paywall-action-interceptor

This JavaScript snippet demonstrates how to fetch offerings, purchase a package, and synchronize with Purchasely upon successful purchase or restore. It includes error handling for purchase failures and user cancellations.

```javascript
try {
  const offerings = await Purchases.getOfferings();
  if (offerings.current !== null && offerings.current.availablePackages.length !== 0) {
    //get your package
    const package = offerings.current.monthly;
    
    //and purchase with RevenueCat
    try {
      const {customerInfo, productIdentifier} = await Purchases.purchasePackage(package);
      if (typeof customerInfo.entitlements.active.my_entitlement_identifier !== "undefined") {
        Purchasely.synchronize(); // synchronize all purchases with Purchasely
      }
      Purchasely.onProcessAction(false); // notify Purchasely paywall to stop processing action
      Purchasely.closePresentation(); // close the current screen displayed by Purchasely
    } catch (e) {
      Purchasely.onProcessAction(false); // notify Purchasely paywall to stop processing action
      if (!e.userCancelled) {
        showError(e);
      }
    }
  }
} catch (e) {
   Purchasely.onProcessAction(false); // notify Purchasely paywall to stop processing action
}
} catch (e) {
  console.log(e);
  Purchasely.onProcessAction(false); // notify Purchasely paywall to stop processing action
}
} else if (result.action === PLYPaywallAction.RESTORE) {
  try {
    const restore = await Purchases.restorePurchases();
    // ... check restored purchaserInfo to see if entitlement is now active
    
    Purchasely.onProcessAction(false); // notify Purchasely paywall to stop processing action
    Purchasely.synchronize(); // synchronize all purchases with Purchasely
    Purchasely.closePresentation(); // close the current screen displayed by Purchasely
  } catch (e) {
    Purchasely.onProcessAction(false); // notify Purchasely paywall to stop processing action
  }
} else {
  Purchasely.onProcessAction(true); // notify Purchasely paywall to continue other actions
}
});
```

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

### Install Google Play Billing Dependency

Source: https://docs.purchasely.com/docs/installation-react-native

Installs the NPM dependency required to integrate Google Play Billing with the Purchasely SDK. This package enables in-app purchases through the Google Play Store.

```shell
npm install @purchasely/react-native-purchasely-google --save
```

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

### Add Purchasely Flutter Dependency

Source: https://docs.purchasely.com/docs/general-flutter

Installs the main Purchasely Flutter SDK package using the Flutter package manager.

```shell
flutter pub add purchasely_flutter
```

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

### Perform Purchase with StoreKit 2 (Swift)

Source: https://docs.purchasely.com/docs/app-store-storekit-1-vs-storekit-2

This Swift code demonstrates how to perform a purchase using StoreKit 2 with async/await. It fetches products, initiates a purchase, and handles the result, including verification and transaction completion. It also shows how to access current entitlements.

```swift
import StoreKit

let products = try await Product.products(for: ["com.myapp.pro_monthly"])
if let product = products.first {
    let result = try await product.purchase()
    switch result {
    case .success(let verification):
        if case .verified(let transaction) = verification {
            // Unlock content  
            await transaction.finish()
        } else {
            // Handle unverified transaction
        }
    case .pending:
        // Ask to Buy / SCA
        break
    case .userCancelled:
        break
    @unknown default:
        break
    }
}


for await transaction in Transaction.currentEntitlements {
    // Automatically includes all active purchases  
    print("User owns: (transaction.productID)")
}
```

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

### Start Purchasely SDK in Java (Android)

Source: https://docs.purchasely.com/docs/sdk-initialization

Initializes the Purchasely SDK within the Android Application class using Java. This setup ensures the SDK is ready from the start of the application lifecycle. Requires the Purchasely Android SDK and Google Play Store dependency.

```java
import android.app.Application
import io.purchasely.ext.Purchasely
import io.purchasely.google.GoogleStore

public class YourApplication extends  Application {

		 @Override
     public void onCreate() {
        super.onCreate()

        Purchasely.Builder(applicationContext)
            .apiKey("00000000-1111-2222-3333-444444444444")
            .stores(listOf(GoogleStore())) // Set the list of stores you want to have
            .build()
            .start { isConfigured, error ->
                if(isConfigured) {
                    // Purchasely setup is complete 
                )
            }
    }
}

```

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

### Initialize Purchasely SDK

Source: https://docs.purchasely.com/docs/revenuecat

Initializes the Purchasely SDK with API key, user ID, running mode, and event delegate. The `start` method should be called as early as possible in your application's lifecycle to ensure all purchases and renewals are captured. The `runningMode` set to `paywallObserver` allows Purchasely to display paywalls and observe transactions without processing them.

```swift
import Purchasely

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    Purchasely.start(withAPIKey: "API_KEY,
                         appUserId: nil,
						runningMode: .paywallObserver,
						eventDelegate: nil,
						logLevel: .debug) { (success, error) in
		print(success)
        }
	return true
}
```

```kotlin
import io.purchasely.ext.Purchasely

Purchasely.Builder(applicationContext)
    .apiKey("API_KEY")
    .logLevel(LogLevel.DEBUG) // set to warning or error for release
    .userId("USER_ID")
    .runningMode(PLYRunningMode.PaywallObserver)
    .stores(listOf(GoogleStore(), HuaweiStore()))
    .build()

// When you are ready for Purchasely to initialize,
// you must call start() method that will grab configuration and products
// from the selected stores.
Purchasely.start { isConfigured ->
}
```

```typescript
import Purchasely from 'react-native-purchasely';

/**
* @params String apiKey
* @params StringArray stores : may be Google, Amazon and Huawei
* @params String userId
* @params Purchasley.LogLevel logLevel
* @params RunningMode runningMode
**/
Purchasely.startWithAPIKey(
  'API_KEY',
  ['Google'],
  'USER_ID',
  Purchasely.logLevelDebug,
  RunningMode.PaywallObserver
);
```

```flutter
/**
* @params String apiKey
* @params StringArray stores : may be Google, Amazon and Huawei
* @params String userId
* @params PLYLogLevel logLevel
* @params PLYRunningMode runningMode
**/
bool configured = await Purchasely.startWithApiKey(
        'API_KEY',
        ['Google'],
        null,
        PLYLogLevel.debug,
        PLYRunningMode.paywallObserver
    );
    
if (!configured) {
        print('Purchasely SDK not configured');
        return;
}
```

```javascript
/**
* @params String apiKey
* @params StringArray stores : may be Google, Amazon and Huawei
* @params String userId
* @params Purchasley.LogLevel logLevel
* @params Purchasely.RunningMode runningMode
**/
Purchasely.startWithAPIKey(
    'API_KEY', 
    ['Google'], 
    null, 
    Purchasely.LogLevel.DEBUG, 
    Purchasely.RunningMode.paywallObserver
);
```

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

### Initialize Purchasely SDK with Web Checkout Interceptor (Swift)

Source: https://docs.purchasely.com/docs/web-checkout

This code snippet demonstrates how to initialize the Purchasely SDK and set up a paywall actions interceptor. It specifically shows how to handle the `.webCheckout` action, extracting parameters like `clientReferenceId`, `queryParameterKey`, `url`, and `webCheckoutProvider`. The interceptor allows developers to either let the SDK handle the web checkout or manage it manually by calling `proceed(false)`.

```swift
Purchasely.start(
    withAPIKey: // your Purchasely API key,
    paywallActionsInterceptor: { action, parameters, presentationInfo, proceed in
        switch action {
        // ... other actions
        case .webCheckout:
            parameters?.clientReferenceId    // The unique reference passed as a query parameter using the provided query parameter key
            parameters?.queryParameterKey    // The query parameter key for the client referenne id. In the case of stripe, the key is `client_reference_id`
            parameters?.url                  // The payment page URL
            parameters?.webCheckoutProvider  // The web checkout provider. "stripe" for Stripe, "other" otherwise

            // store the client reference id to simplify reconciliation
            proceed(true)                    // If you want the Purchasely SDK to handle the action and display the payment page. Else, call `proceed(false)` and have your app should handle displaying the web page.
        }
    },
    storekitSettings: // your StoreKit setting
)
```

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

### Get Anonymous User ID with Purchasely SDK

Source: https://docs.purchasely.com/docs/general-user-identification

Retrieve the unique anonymous user ID generated by the Purchasely SDK. This ID remains consistent as long as the app is installed on the device. This functionality is available across multiple platforms.

```swift
Purchasely.anonymousUserId
```

```kotlin
Purchasely.anonymousUserId
```

```typescript
Purchasely.getAnonymousUserId();
```

```flutter
Purchasely.anonymousUserId;
```

```javascript
Purchasely.getAnonymousUserId((anonymousId) => {
	console.log("Purchasely anonymous Id: " + anonymousId);
});
```

```csharp
_purchasely.GetAnonymousUserId();
```

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

### Handle Purchasely SDK Initialization Callback (Kotlin)

Source: https://docs.purchasely.com/docs/sdk-implementation

Provides an example of using the initialization callback for the Purchasely SDK. This callback is crucial for actions that depend on accurate subscription status or for displaying audience-based placements.

```kotlin
Purchasely.start(context, "YOUR_API_KEY") {
    override fun onReady(success: Boolean, error: PurchaselyError?) {
        if (success) {
            // SDK initialized successfully, proceed with subscription checks or UI updates
        } else {
            // Handle initialization error
            Log.e("Purchasely", "Initialization failed: ${error?.message}")
        }
    }
}
```

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

### Start Purchasely SDK - React Native

Source: https://docs.purchasely.com/docs/general-sdk-initialization

Initializes the Purchasely SDK for React Native applications. The `start` method takes an object with configuration options including apiKey, logLevel, and userId. It's recommended to use a try-catch block to handle potential configuration errors.

```typescript
import Purchasely from 'react-native-purchasely';

// Everything is optional except apiKey and storeKit1
// Example with default values
try {
    const configured = await Purchasely.start({
        apiKey: '00000000-1111-2222-3333-444444444444',
        logLevel: LogLevels.ERROR, // set to debug in development mode to see logs
        userId: null // if you know your user id, set it here
     });
} catch (e) {
     console.log("Purchasely SDK not configured properly");
}
```

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

### Install Purchasely SDK for iOS (CocoaPods)

Source: https://docs.purchasely.com/docs/general-sdk-installation

This snippet shows how to install the Purchasely SDK for iOS using CocoaPods. It specifies the 'Purchasely' pod to be included in your Podfile.

```ruby
pod 'Purchasely'
```

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

### Install Purchasely SDK for Cordova (npm/yarn)

Source: https://docs.purchasely.com/docs/general-sdk-installation

This code snippet demonstrates how to install the Purchasely SDK for Cordova by adding 'cordova-plugin-purchasely' to your project's dependencies in package.json. It uses a caret version range for updates.

```json
"dependencies": {
    "cordova-plugin-purchasely": "^4.0.0"
  }
```

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

### Fetch and Display Presentation using Purchasely SDK

Source: https://docs.purchasely.com/docs/display-mode

Demonstrates how to fetch a presentation using a placement ID and then display it. This process involves an asynchronous call to `fetchPresentation` and subsequent use of the `display` method. Error handling is included. Note that the source UIViewController is optional in Swift.

```swift
Purchasely.fetchPresentation(for: "onboarding", fetchCompletion: { presentation, error in
      guard error == nil,
            let presentation = presentation else { return }
                                                                  
     // Calling display() to launch the flow
	 // Source UIViewController is optional 
     presentation.display(from: myUIViewController) 

})

// If for some specific configuration you need to check if the presentation is a flow, that's possible but it should only be done if required by your implementation
if presentation.isFlow {
  // presentation is a flow
  presentation.display()
}
```

```kotlin
Purchasely.fetchPresentation(placementId = "onboarding") { presentation, error ->
  if(error != null) {
    Log.d("Purchasely", "Error fetching Screen", error)
    return@fetchPresentation
  }
  
  // Calling display() to launch the flow 
  presentation?.display(context)
}

// If for some specific configuration you need to check if the presentation is a flow, that's possible but it should only be done is required by your implementation
if (presentation.flowId != null) {
	// presentation is a flow
}
```

```javascript
try {
  // Fetch presentation to display
  const presentation = await Purchasely.fetchPresentation({
      placementId: 'onboarding'
  })

  if(presentation.type == PLYPresentationType.DEACTIVATED) {
    // No Screen to display
    return
  }

  if(presentation.type == PLYPresentationType.CLIENT) {
    // Display my own Screen
    return
  }

  //Display Purchasely Screen
  await Purchasely.presentPresentation({
    presentation: presentation
  })

} catch (e) {
  console.error(e);
}
```

```dart
try {
  var presentation = await Purchasely.fetchPresentation("onboarding");

  if (presentation == null) {
    print("No presentation found");
    return;
  }

  if (presentation.type == PLYPresentationType.deactivated) {
    // No Screen to display
    return;
  }

  if (presentation.type == PLYPresentationType.client) {
    // Display my own Screen
    return;
  }

  //Display Purchasely Screen

  await Purchasely.presentPresentation(presentation,
      isFullscreen: false);

} catch (e) {
  print(e);
}
```

```cordova
Purchasely.fetchPresentationForPlacement(
		'onboarding', //placementId
		null, //contentId
		(presentation) => {
			Purchasely.presentPresentation(presentation, false, null,
				(callback) => {
				},
				(error) => {
					console.log("Error with present : " + error);
				});
		},
		(error) => {
			console.log("Error with purchase : " + error);
		}
	);
```

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

### Install Purchasely SDK for React Native (npm/yarn)

Source: https://docs.purchasely.com/docs/general-sdk-installation

This code snippet shows how to install the Purchasely SDK for React Native by adding 'react-native-purchasely' to your project's dependencies in package.json. It uses a caret version range for updates.

```json
"dependencies": {
    "react-native-purchasely": "^5.0.0"
  }
```

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

### Start Purchasely SDK with User ID

Source: https://docs.purchasely.com/docs/general-user-identification

Initialize the Purchasely SDK with an API key and an optional user ID for logged-in users. If a user is already logged in when the SDK starts, the user ID can be provided directly in the start method. This method is crucial for persistent user identification across sessions.

```swift
import Purchasely

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    Purchasely.start(
       withAPIKey: "00000000-1111-2222-3333-444444444444",
       appUserId: "XYZ-123-ABC-456" // user ID
       logLevel: .debug
    ) {(success, error) in
      print(success)
    }
	return true
}
```

```kotlin
import android.app.Application
import io.purchasely.ext.Purchasely
import io.purchasely.google.GoogleStore

class YourApplication: Application() {

    override fun onCreate() {
        super.onCreate()

        Purchasely.Builder(applicationContext)
            .apiKey("00000000-1111-2222-3333-444444444444")
            .userId("XYZ-123-ABC-456") // user ID
            .build()
            .start { isConfigured, error ->
                if(isConfigured) {
                    // Purchasely setup is complete 
                )
            }
    }
}
```

```typescript
import Purchasely from 'react-native-purchasely';

// Everything is optional except apiKey and storeKit1
// Example with default values
try {
    const configured = await Purchasely.start({
        apiKey: '00000000-1111-2222-3333-444444444444',
        logLevel: LogLevels.ERROR, // set to debug in development mode to see logs
      userId: "XYZ-123-ABC-456" // user ID
    });
 
} catch (e) {
     console.log("Purchasely SDK not configured properly");
}
```

```flutter
// Everything is optional except apiKey and storeKit1
// Example with default values
bool configured = await Purchasely.start(
        apiKey: '00000000-1111-2222-3333-444444444444',
        logLevel: PLYLogLevel.error, // set to debug in development mode to see logs
        userId: "XYZ-123-ABC-456"    // user ID
      );
    
if (!configured) {
        print('Purchasely SDK not configured');
        return;
}
```

```javascript
/*** 
* @params String apiKey
* @params StringArray stores : may be Google, Amazon and Huawei
* @params String userId
* @params Purchasley.LogLevel logLevel
* @params Purchasely.RunningMode runningMode
**/
Purchasely.startWithAPIKey(
    '00000000-1111-2222-3333-444444444444', 
    ['Google'],
    "XYZ-123-ABC-456", // user ID 
    Purchasely.LogLevel.DEBUG 
);
```

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

### Fetch and Present Content in Unity C#

Source: https://docs.purchasely.com/docs/pre-fetching

This C# Unity snippet shows how to fetch a presentation using the Purchasely SDK. It includes callbacks for success and logging, and handles different presentation types like Normal, Fallback, Unknown, Deactivated, and Client.

```csharp
private PurchaselyRuntime.Purchasely _purchasely;

... // Initialization code for _purchasely
_purchasely.FetchPresentation("presentationId",
			OnFetchPresentationSuccess,
			Log,
			"contentId");		
...

private void OnFetchPresentationSuccess(Presentation presentation)
{
	Log("Fetch Presentation Success.");
	LogPresentation(presentation);

	switch (presentation.presentationType)
	{
		case PresentationType.Normal:
		case PresentationType.Fallback:
				_purchasely.PresentContentForPresentation(
          	presentation,
						OnPresentationResult,
						OnPresentationContentLoaded,
						OnPresentationContentClosed,
						true
				);
			break;
		case PresentationType.Unknown:
		case PresentationType.Deactivated:
			Log($"Fetched presentation with type: {presentation.presentationType}. Will not show content.");
			break;
		case PresentationType.Client:
			paywall.Show(presentation);
			break;
	}
}
```

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

### Example Server Event Payload for Airship

Source: https://docs.purchasely.com/docs/airship

This is an example JSON payload representing a 'purchase_validated' event sent from Purchasely to Airship. It includes details about the purchase and the user.

```json
{
  "body": {
    "name": "purchase_validated_server",
    "properties": {
      "application_name": "Purchasely",
      "application_package_id": "com.purchasely",
      "application_platform": "IOS",
      "plan_id": "PURCHASELY_PLUS_MONTHLY",
      "plan_name": "Monthly",
      "plan_store_product_id": "com.purchasely.plus.monthly",
      "plan_type": "RENEWING_SUBSCRIPTION",
      "product_id": "PURCHASELY_PLUS",
      "product_name": "Purchasely +",
      "store": "APPLE_APP_STORE"
    }
  },
  "occurred":"2021-03-24T17:15:01",
  "user":{
    "named_user_id": "jg"
  }
}
```
Tokens:
Raw