You can record App Store and Play Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an AdjustAppStoreSubscription
or AdjustPlayStoreSubscription
instance containing the details.
1. Instantiate a subscription object
To get started, you need to create a subscription object containing details of the subscription purchase.
Create an AdjustAppStoreSubscription
object with the following properties:
Parameter | Data type | Description |
---|---|---|
price | string | The price of the subscription |
currency | string | The currency of the subscription. Formatted as the currencyCode of the priceLocale object |
transactionId | string | Your ID for the transaction |
receipt | string | The receipt information |
Create an AdjustPlayStoreSubscription
object with the following properties:
Parameter | Data type | Description |
---|---|---|
price | string | The price of the subscription |
currency | string | The currency of the subscription |
sku | string | The ID of the product |
orderId | string | Your ID for the transaction |
signature | string | The signature of the purchase data |
purchaseToken | string | The unique token of the transaction. See Google’s documentation for more information |
Record the purchase date
You can record the date on which the user purchased a subscription. The SDK returns this data for you to report on.
Call the setTransactionDate
method on your subscription object to record the timestamp of the subscription.
Call the setPurchaseTime
method on your subscription object to record the timestamp of the subscription.
Record the purchase region (iOS only)
You can record the region in which the user purchased a subscription. To do this, call the setSalesRegion
method on your subscription object and pass the country code as a string
. This needs to be formatted as the countryCode
of the priceLocale
object.
Add callback parameters
You can add callback parameters to your subscription object. The SDK appends these parameters to your callback URL. To add callback parameters, call the addCallbackParameter
method on your subscription object. You can add multiple callback parameters by calling this method multiple times.
Add partner parameters
You can add partner parameters to your subscription object. The SDK sends these to Adjust’s servers when the user purchases a subscription. Adjust’s servers forward the information on to your network partner. To add partner parameters, call the addPartnerParameter
method on your subscription object. You can add multiple partner parameters by calling this method multiple times.
2. Record subscription information
Once you have set up your subscription object, you can record it using the Adjust SDK.
Pass your subscription object to the trackAppStoreSubscription
method to record the user’s subscription purchase.
Pass your subscription object to the trackPlayStoreSubscription
method to record the user’s subscription purchase.