requestPriceIncreaseConsentForTransaction(identifier:)
Simulates a price increase that requires customer consent for an auto-renewable subscription.
Declaration
func requestPriceIncreaseConsentForTransaction(identifier: Int) throwsParameters
- identifier:
The transaction Identifier of the auto-renewable subscription to get a pending price increase.
Discussion
Use this method to test how your app handles a price increase consent flow. When you call this method, the testing environment assigns a pending price increase to the subscription indicated by the identifier. It also sends the price increase consent message to your app. Note that in the testing environment, changing the price of the subscription is optional.
You may call this method repeatedly to prompt the testing environment to send the price increase consent message.
By default, if your app doesn’t listen for messages or implement paymentQueueShouldShowPriceConsent(_:), the system displays the price increase consent sheet immediately. Your app may delay displaying the sheet to ensure a good user experience. For more information, see Message.Messages for apps that run in iOS 16 and later, and paymentQueueShouldShowPriceConsent(_:) and showPriceConsentIfNeeded() for apps that run in earlier versions.
When the system displays the price increase consent sheet, it awaits a response from the user, which may be one of the following:
The user consents to the price increase.
The user does nothing. The subscription expires at the end of the subscription period.
The user cancels the subscription.
See the sections below for information about simulating these user responses in the testing environment. The system removes the pending price increase status when the user consents to the price increase, the subscription expires, or the user cancels the subscription and auto-renew is disabled.
For more information about increasing prices of auto-renewable subscriptions, see Managing prices.
Test with dialogs enabled
Start with disableDialogs set to false, so the system displays the price increase consent sheet in the testing environment.
To simulate a user consenting to a price increase, the tester consents to the price increase in the sheet. The auto-renewable subscription renews at the next renewal period.
To simulate a user not responding to the price increase, the tester closes the price increase consent sheet without consenting. The auto-renewable subscription expires at the end of the renewal period because the user didn’t consent to the price increase. To speed up the subscription expiration in the testing environment, set a shorter time rate in the timeRate variable.
To simulate a user canceling their subscription, the tester closes the price increase consent sheet without consenting. On the next sheet, select to cancel the subscription. The auto-renewable subscription doesn’t renew at the next renewal period.
Test with dialogs disabled
Start with disableDialogs set to true, so the system doesn’t displays the price increase consent sheet in the testing environment.
To simulate a user consenting to a price increase, call consentToPriceIncreaseForTransaction(identifier:). The auto-renewable subscription renews at the next renewal period.
To simulate a user not responding to the price increase consent, wait until the end of the subscription’s renewal period. The auto-renewable subscription expires because the user didn’t consent to the price increase. To speed up the subscription expiration in the testing environment, set a shorter time rate in the timeRate variable.
To simulate the user canceling their subscription, call declinePriceIncreaseForTransaction(identifier:). The subscription doesn’t renew at the next renewal period because the auto-renew setting is off.