Anonymous user

Why anonymous ?

If your app can be used without requiring the user to register (like news app) and you want to offer purchases to unlock content, Apple will refuse that you force the user to register to subscribe.

In that case you will have to handle anonymous purchases (aka unregistered user purchases).

Purchasely helps you combine the power of Server to Server notifications (S2S) with anonymous purchases.

Consumable and non-consumables won't be transfered from an anonymous user to a authentified user

Handling anonymous purchasing

To handle anonymous users, Purchasely SDK automatically generates an anonymous_id for the user. This anonymous_id remains consistent as long as the user keeps the app on its device.

Anonymous Purchasing - General Process
  1. The anonymous user purchase a product → Purchasely SDK generates an anonymous_id

  2. Once the store receipt validated, an event carrying this anonymous_id is sent on the webhook

  3. The association between the anonymous_id and the Product & Plan purchased must be stored in the developer database.

  4. The app can use a dedicated method of the SDK to get the anonymous_id from the SDK and check with the database that the user can access the content / service.

1. Proceeding with an anonymous Purchase

If no userId has been attached to the user by the app to Purchasely SDK, the user will be treated as an anonymous user.

When an anonymous user makes an In-App Purchase, the platform will automatically associate it to the anonymous_id for the user. This anonymous_id is tied to this particular device and remains consistent as long as the app remains installed on the device and will be the key for your backend to authorize the purchase on the device.

2. Getting the user anonymous_id from the webhook

When an event occurs on a subscription made by an anonymous user, the webhook message carries the user anonymous_id generated by Purchasely.

{
"name": "PURCHASE_VALIDATED",
"user": {
"anonymous_id": "a5904f9f-8606-458b-8fc0-f5707ef91cbe"
},
"properties": {
"product": {
"vendor_id": "PURCHASELY_PLUS",
"plan": {
"type": "RENEWING_SUBSCRIPTION",
"vendor_id": "PURCHASELY_PLUS_MONTHLY"
}
},
"store": "APPLE_APP_STORE", // can be GOOGLE_PLAY_STORE | HUAWEI_APP_GALLERY
"app": {
"platform": "IOS", // can be ANDROID
"package_id": "io.purchasely.app"
},
"expires_at": "2020-09-25T14:30:37.000Z",
"purchased_at": "2020-08-25T14:30:37.000Z"
},
"received_at": "2020-08-25T14:31:04.469Z"
}

3. Attaching the purchase to the anonymous user

Purchases and corresponding entitlements must be attached to the anonymous user and stored in your database, using the anonymous_id.

Every subsequent purchase or event for this particular user will carry the same anonymous_id. In other words, when a particular event (renewal / cancellation / expiration etc...) happens on an anonymous user subscription, it will carry the same anonymous_id.

4. Getting user entitlements & anonymous_id in the app

Entitlements are managed by the developer backend and directly attached to the anonymous_id. The app can retrieve the anonymous_id from the SDK vy using the following method :

Swift
Objective-C
Kotlin
Java
React Native
Swift
Purchasely.anonymousUserId
Objective-C
[Purchasely anonymousUserId];
Kotlin
Purchasely.anonymousUserId
Java
Purchasely.getAnonymousUserId();
React Native
Purchasely.getAnonymousUserId();

To ease customer support, we advise you to display both anonymous_id and user_id inside your app (e.g. in the section "My Subscriptions", in the settings or in the contact-us mail). This will help you identify the user in the Purchasely Console or in your own logs.

Authentication of an anonymous user

To authenticate an anonymous user, just set the appUserId. If your user had a subscription we will transfer it to the connected user. That implies sending events to your backend and wait for it to confirm before you try to refresh your entitlements. This is why you have a closure that passes a boolean telling you if the entitlements of the logged in user should be refreshed.

Swift
Objective-C
Kotlin
Java
React Native
Swift
Purchasely.userLogin(with: "123456789") { (shouldRefreshCredentials) in
if (shouldRefreshCredentials) {
// You should call your backend to refresh user entitlements
}
}
Objective-C
[Purchasely userLoginWith:@"123456789" shouldRefresh:^(BOOL shouldRefreshCredentials) {
if (shouldRefreshCredentials) {
// You should call your backend to refresh user entitlements
}
}];
Kotlin
Purchasely.userLogin("123456789") { refresh ->
if (refresh) {
// You should call your backend to refresh user entitlements
}
}
Java
Purchasely.userLogin("123456789", refresh -> {
if(refresh) {
// You should call your backend to refresh user entitlements
}
return null;
});
React Native
Purchasely.userLogin('123456789').then((refresh) => {
if (refresh) {
// You should call your backend to refresh user entitlements
}
});

Do not forget to call Purchasely.userLogin("YOUR_USER_ID")before returning the result to Purchasely to properly update the presentation without the sign-in button.

Once the user has been connected all the purchased subscriptions are transferred from the anonymous user, to the connected user. User entitlements shall thus be refreshed by the App.

The Webhook will receive 2 events, a PURCHASE_VALIDATED for the connected user and a SUBSCRIPTION_EXPIRED for the anonymous user.

{
"name": "SUBSCRIPTION_EXPIRED",
"user": {
"anonymous_id": "a5904f9f-8606-458b-8fc0-f5707ef91cbe"
},
"properties": {
"product": {
"vendor_id": "PURCHASELY_PLUS",
"plan": {
"type": "RENEWING_SUBSCRIPTION",
"vendor_id": "PURCHASELY_PLUS_MONTHLY"
}
},
"store": "APPLE_APP_STORE",
"app": {
"package_id": "io.purchasely.app",
"platform": "IOS"
},
"expires_at": "2021-02-16T09:02:56.000Z",
"purchased_at": "2021-02-16T08:57:56.000Z"
},
"received_at": "2021-02-16T08:59:14.985Z"
}
{
"name": "PURCHASE_VALIDATED",
"user": {
"vendor_id": "123456789"
},
"properties": {
"product": {
"vendor_id": "PURCHASELY_PLUS",
"plan": {
"type": "RENEWING_SUBSCRIPTION",
"vendor_id": "PURCHASELY_PLUS_MONTHLY"
}
},
"store": "APPLE_APP_STORE",
"app": {
"package_id": "io.purchasely.app",
"platform": "IOS"
},
"expires_at": "2021-02-16T09:02:56.000Z",
"purchased_at": "2021-02-16T08:57:56.000Z"
},
"received_at": "2021-02-16T08:59:15.015Z"
}

Intercept paywall actions

Every presentation, has a Already subscribed? Sign-in button to let your customers connect to unlock a feature / access a content. This button is displayed if you did not set a user id with Purchasely.userLogin() see SDK configuration for more information.

To intercept this event, you can setup a global handler that passes you the source paywall controller / fragment above which to display login.

  • IF the user signs in AND has a subscription, you can dismiss the paywall controller

  • IF the user signs in AND doesn't have a subscription, dismiss your login controller and notify the SDK by calling the isLoggedIn closure with true

  • IF the user cancels sign-in, dismiss your login controller and notify the SDK by calling the isLoggedIn closure with false

Swift
Objective-C
Kotlin
Java
Swift
Purchasely.setLoginTappedHandler { (paywallController, isLoggedIn) in
// Get your login controller
loginCtrl = LoginViewController()
// Configure the response to notify Purchasely that it needs to reload (if needed)
loginCtrl.configure(with: isLoggedIn)
paywallController.present(loginCtrl, animated: true, completion: nil)
}
Objective-C
[Purchasely setLoginTappedHandler:^(UIViewController * paywallController, void (^ isLoggedIn)(BOOL)) {
// Get your login controller
LoginViewController *loginCtrl = LoginViewController()
// Configure the response to notify Purchasely that it needs to reload (if needed)
[loginCtrl configureWith: isLoggedIn];
[paywallController presentViewController:loginCtrl animated:YES completion:nil];
}];
Kotlin
Purchasely.setLoginTappedHandler { activity, isLoggedIn ->
// If there is no activity then there is nothing to display
if (activity == null) return@setLoginTappedHandler
// Call your method to display your view
// and return boolean result to userLoggedIn
presentLogin(activity) { userLoggedIn ->
// Don't forget to notify the SDK by calling `isLoggedIn`
isLoggedIn(userLoggedIn)
}
}
Java
Purchasely.setLoginTappedHandler((activity, listener) -> {
//if there is no activity then there is nothing to display
if (activity == null) return;
/* call your method to display your view
and return boolean result to listener
listener.userLoggedIn(userLoggedIn);
*/
presentLogin(activity, listener);
});
//You can also use the method for kotlin with Function interface

Do not forget to call Purchasely.userLogin("YOUR_USER_ID")before returning the result to Purchasely to properly update the presentation without the sign-in button.