Offer discounted pricing for auto-renewable subscription products to eligible subscribers.
Subscription offers can be effective in winning back lapsed subscribers or retaining current subscribers. You can provide lapsed or current subscribers a limited-time offer of a discounted or free period of service for auto-renewable subscriptions on macOS, iOS, and tvOS. To implement the offers, first complete the setup on App Store Connect, including generating a private key. See Setting Up Subscription Offers for more details.
You decide the criteria for which subscribers qualify for an offer. In your app, the details of the offers you set up in App Store Connect appear in the
discounts array in
SKProduct. To indicate the offer you want to give to a user, include a signed
payment in the
For business guidance on using subscription offers, see Auto-renewable Subscriptions > Subscription Offers.
Prepare Your Offer
To present a subscription offer, first determine the subscriber’s eligibility, get the product details from the App Store, and generate a signature on your server.
There are two aspects to determining a user’s eligibility for a subscription offers:
The App Store deems all customers with an existing or expired subscription in the app eligible to redeem a subscription offer. You can check whether the receipt contains any existing or expired subscription purchases to identify these current or lapsed subscribers.
You determine any additional eligibility criteria for a specific subscription offer. Eligibility can be contingent on a wide range of business logic determined by your business needs.
Consider using the server-to-server notification
DID to determine eligibility. This notification is triggered by changes in a subscription’s auto-renew status. For example, you receive a notification when a subscriber disables auto-renew in Manage Subscriptions or contacts AppleCare to cancel their subscription. For more information on server notifications, see Enabling Server-to-Server Notifications. Your server can notify your app if the user is eligible for an offer so the app can present it to the customer.
Consider also implementing DeviceCheck to keep track of devices that have previously redeemed offers. DeviceCheck allows you to maintain user privacy while defining parameters you use to determine eligibility.
Request Product Details
Once you determine that the subscriber is eligible for an offer, the next step is requesting the product details, including offers, from the App Store. To fetch the details, use
SKProducts with the subscription’s product identifier.
In response, the App Store returns the localized information in
discounts array of
SKProduct contains all subscription offers you configured in App Store Connect for that product. The
SKProduct object contains offer details including the localized price.
You determine which offer from the
discounts array to present to the user.
Create a Signature
A signature is a unique string that your server generates using specified parameters and your private key. You include it in the
signature parameter of
SKPayment, and the App Store uses it to validate the subscription offer. The signature is time sensitive, unique per offer, and redeemable only once.
To generate the signature, send a secure request to your server. The server will need to know the
identifier. Your app should supply these parameters in the request if the server doesn't already know them. See Generating a Signature for Subscription Offers for more information.
Your server should respond with the signature string and the additional values it used to generate the signature: a
timestamp, and the
key. Use these values to complete the parameters in the
SKPayment object nested in the
SKMutable object representing the offer. If the App Store determines that the signature is not a match for the parameters in the payment, the transaction fails.
The following code example shows how to request a signature from your server and prepare the discount offer.
Present Your Offer
You can present offers to users through various channels, such as email, but they must interact with the offer inside your app’s UI. Display the offer in your app at the time you choose, using the pricing and terms from the
SKProduct object. By using the details from this object, you ensure that the offer displayed to the user accurately reflects the offer you intend to give. For design guidance, see Auto-Renewable Subscriptions > Clearly Describing Subscriptions.
Present offers to eligible subscribers only, to avoid misleading or confusing users.
Complete the Transaction
After a user chooses to buy the subscription offer, submit the payment request, verify the receipt, and unlock the offer.
Create a Payment Request
When the user initiates a buy of the offer in the app, send an
SKMutable to the App Store with the signed offer. Create an
SKPayment object that includes the signature you generated and its
nonce (one-time use), and
timestamp parameters. Add this object as the
payment property to the
Notify the User of the Transaction State
Once the App Store validates the offer, it processes your payment request and generates an
SKPayment. Your app uses it to validate the transaction and unlock content accordingly.
Handle the transaction state of the payment request and notify the customer as needed. If the transaction is successful, the App Store automatically updates the app receipt with the transaction in the
SKPayment state. Base64-encode the receipt on-device and securely send the receipt data to your server.
Verify the Receipt
As you do for all purchases, verify the receipt with the App Store by calling the
verify endpoint from your server. The App Store sends a JSON response containing information about the user’s purchase. See Validating Receipts With the App Store for more information.
When a subscriber redeems an offer, the receipt contains a
promotional in the purchase transaction. This receipt field is a string containing the offer ID that you configured in App Store Connect. You can look at past transactions in the receipt to identify the offers the customer redeemed.
Unlock the Service
After validating that the user has purchased the subscription product, unlock the subscription service in the app for the user. Update the customer’s eligibility criteria for offers, as needed.
When a customer redeems a subscription offer, the offer period starts at the next billing event.
For upgrades or crossgrades to a different subscription with the same duration, the subscription offer triggers a billing event and goes into effect immediately.
For downgrades or crossgrades to a different subscription with different durations, the subscription offer period goes into effect at the next renewal date.
For the same subscription in an introductory offer, this subscription offer period goes into effect at the next scheduled billing event.
Once the offer period concludes, a subscription offer auto-renews at the standard price.
A user can redeem and have active only one subscription offer at a time. If the user accepts another offer before a current offer ends, the current offer is canceled in the following billing event and the new offer takes effect.