Send subscription information

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.

App Store
Play Store

AdjustAppStoreSubscription(String _price, String _currency, String _transactionId)

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 | |

1
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
2
   price,
3
   currency,
4
   transactionId);

AdjustPlayStoreSubscription(String _price, String _currency, String _sku, String _orderId, String _signature, String _purchaseToken)

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

1
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
2
   price,
3
   currency,
4
   sku,
5
   orderId,
6
   signature,
7
   purchaseToken);

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.

App Store
Play Store

Add the transactionDate property in the AdjustAppStoreSubscription class.

String? transactionDate

Set a timestamp to the transactionDate property of your subscription instance to record the date on which the user purchased a subscription.

1
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
2
   price,
3
   currency,
4
   transactionId);
5
//...
6
subscription.transactionDate = 'transactionDate';

Add the purchaseTime property in the AdjustPlayStoreSubscription class.

String? purchaseTime;

Set a timestamp to the purchaseTime property of your subscription instance to record the date on which the user purchased a subscription.

1
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
2
   price,
3
   currency,
4
   sku,
5
   orderId,
6
   signature,
7
   purchaseToken);
8
subscription.purchaseTime = 'purchase-time';

Record the purchase region (iOS only)

String? salesRegion

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 Storefront object.

1
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
2
   price,
3
   currency,
4
   transactionId);
5
//...
6
subscription.salesRegion = 'sales-region';

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.

App Store
Play Store

void addCallbackParameter(String key, String value)

1
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
2
   price,
3
   currency,
4
   transactionId);
5
//...
6
subscription.addCallbackParameter('key1', 'value1');
7
subscription.addCallbackParameter('key2', 'value2');

void addCallbackParameter(String key, String value)

1
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
2
   price,
3
   currency,
4
   sku,
5
   orderId,
6
   signature,
7
   purchaseToken);
8
//...
9
subscription.addCallbackParameter('key1', 'value1');
10
subscription.addCallbackParameter('key2', 'value2');

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.

App Store
Play Store

void addPartnerParameter(String key, String value)

1
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
2
   price,
3
   currency,
4
   transactionId);
5
//...
6
subscription.addPartnerParameter('key1', 'value1');
7
subscription.addPartnerParameter('key2', 'value2');

void addPartnerParameter(String key, String value)

1
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
2
   price,
3
   currency,
4
   sku,
5
   orderId,
6
   signature,
7
   purchaseToken);
8
//...
9
subscription.addPartnerParameter('key1', 'value1');
10
subscription.addPartnerParameter('key2', 'value2');

2. Record subscription information

Once you have set up your subscription object, you can record it using the Adjust SDK.

App Store
Play Store

static void trackAppStoreSubscription(AdjustAppStoreSubscription subscription)

Pass your subscription object to the trackAppStoreSubscription method to record the user’s subscription purchase.

1
AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
2
   price,
3
   currency,
4
   transactionId);
5
subscription.transactionDate = 'transactionDate';
6
subscription.salesRegion = 'salesRegion';
7
subscription.addCallbackParameter('key1', 'value1');
8
subscription.addCallbackParameter('key2', 'value2');
9
subscription.addPartnerParameter('key1', 'value1');
10
subscription.addPartnerParameter('key2', 'value2');
11

12
Adjust.trackAppStoreSubscription(subscription);

static void trackPlayStoreSubscription(AdjustPlayStoreSubscription subscription)

Pass your subscription object to the trackPlayStoreSubscription method to record the user’s subscription purchase.

1
AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
2
   price,
3
   currency,
4
   sku,
5
   orderId,
6
   signature,
7
   purchaseToken);
8
subscription.purchaseTime = 'purchase-time';
9
subscription.addCallbackParameter('key1', 'value1');
10
subscription.addCallbackParameter('key2', 'value2');
11
subscription.addPartnerParameter('key1', 'value1');
12
subscription.addPartnerParameter('key2', 'value2');
13

14
Adjust.trackPlayStoreSubscription(subscription);