Send subscription information

You can record App Store subscriptions and verify their validity with the Adjust SDK. After the user purchases a subscription, create an ADJAppStoreSubscription instance containing the details.

1. Instantiate a subscription object

- (nullable id)initWithPrice:(nonnull NSDecimalNumber *)price
                    currency:(nonnull NSString *)currency
               transactionId:(nonnull NSString *)transactionId;

To get started, you need to create a subscription object containing details of the subscription purchase. To do this, initialize an ADJAppStoreSubscription object using the initWithPrice method. Pass the following arguments:

Parameter	Data type	Description
`price`	`NSDecimalNumber`	The price of the subscription
`currency`	`NSString`	The currency of the subscription. Formatted as the `currencyCode` of the `priceLocale` object
`transactionId`	`NSString`	Your ID for the transaction

Swift
Objective-C

1
let subscription = ADJAppStoreSubscription(
2
    price: price,
3
    currency: currency,
4
    transactionId: transactionId

1
ADJAppStoreSubscription *subscription = [[ADJAppStoreSubscription alloc] initWithPrice:price
2
                                                                        currency:currency
3
                                                                        transactionId:transactionId];

Record the purchase date

- (void)setTransactionDate:(nonnull NSDate *)transactionDate;

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 with a timestamp to record this information.

Swift
Objective-C

1
guard let subscription = ADJAppStoreSubscription(
2
    price: price,
3
    currency: currency,
4
    transactionId: transactionId) else { return }
5
// ...
6
subscription.setTransactionDate(transactionDate)

1
ADJAppStoreSubscription *subscription = [[ADJAppStoreSubscription alloc] initWithPrice:price
2
                                                                        currency:currency
3
                                                                        transactionId:transactionId];
4
/// ...
5
[subscription setTransactionDate:transactionDate];

Record the purchase region

- (void)setSalesRegion:(nonnull NSString *)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 an NSString. This needs to be formatted as the countryCode of the Storefront object.

Swift
Objective-C

1
guard let subscription = ADJAppStoreSubscription(
2
    price: price,
3
    currency: currency,
4
    transactionId: transactionId) else { return }
5
// ...
6
subscription.setSalesRegion(salesRegion)

1
ADJAppStoreSubscription *subscription = [[ADJAppStoreSubscription alloc] initWithPrice:price
2
                                                                        currency:currency
3
                                                                        transactionId:transactionId];
4
/// ...
5
[subscription setSalesRegion:salesRegion];

Add callback parameters

- (void)addCallbackParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

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.

Swift
Objective-C

1
guard let subscription = ADJAppStoreSubscription(
2
    price: price,
3
    currency: currency,
4
    transactionId: transactionId) else { return }
5
// ...
6
subscription.addCallbackParameter("key1", value: "value1")
7
subscription.addCallbackParameter("key2", value: "value2")

1
ADJAppStoreSubscription *subscription = [[ADJAppStoreSubscription alloc] initWithPrice:price
2
                                                                        currency:currency
3
                                                                        transactionId:transactionId];
4
/// ...
5
[subscription addCallbackParameter:@"key1" value:@"value1"];
6
[subscription addCallbackParameter:@"key2" value:@"value2"];

Add partner parameters

- (void)addPartnerParameter:(nonnull NSString *)key value:(nonnull NSString *)value;

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.

Swift
Objective-C

1
guard let subscription = ADJAppStoreSubscription(
2
    price: price,
3
    currency: currency,
4
    transactionId: transactionId) else { return }
5
// ...
6
subscription.addParameterParameter("key1", value: "value1")
7
subscription.addParameterParameter("key2", value: "value2")

1
ADJAppStoreSubscription *subscription = [[ADJAppStoreSubscription alloc] initWithPrice:price
2
                                                                        currency:currency
3
                                                                        transactionId:transactionId];
4
/// ...
5
[subscription addParameterParameter:@"key1" value:@"value1"];
6
[subscription addParameterParameter:@"key2" value:@"value2"];

2. Send subscription information

+ (void)trackAppStoreSubscription:(nonnull ADJAppStoreSubscription *)subscription;

Once you have set up your subscription object, you can send it to Adjust using the Adjust SDK. Pass your completed object to the trackAppStoreSubscription method to record the user’s subscription purchase.

Swift
Objective-C

1
guard let subscription = ADJAppStoreSubscription(
2
    price: price,
3
    currency: currency,
4
    transactionId: transactionId) else { return }
5

6
subscription.setTransactionDate(transactionDate)
7
subscription.setSalesRegion(salesRegion)
8

9
// Add callback parameters
10
subscription.addCallbackParameter("key1", value: "value1")
11
subscription.addCallbackParameter("key2", value: "value2")
12

13
// Add partner parameters
14
subscription.addPartnerParameter("key1", value: "value1")
15
subscription.addCallbackParameter("key2", value: "value2")
16

17
Adjust.trackAppStoreSubscription(subscription)

1
ADJAppStoreSubscription *subscription = [[ADJAppStoreSubscription alloc] initWithPrice:price
2
                                                                        currency:currency
3
                                                                        transactionId:transactionId
4
[subscription setTransactionDate:transactionDate];
5
[subscription setSalesRegion:salesRegion];
6

7
/// Add callback parameters
8
[subscription addCallbackParameter:@"key1" value:@"value1"];
9
[subscription addCallbackParameter:@"key2" value:@"value2"];
10

11
/// Add partner parameters
12
[subscription addPartnerParameter:@"key1" value:@"value1"];
13
[subscription addPartnerParameter:@"key2" value:@"value2"];
14

15
[Adjust trackAppStoreSubscription:subscription];