Professional Documents
Culture Documents
Contents
Introduction 5
At a Glance 6
Configure Your In-App Purchase Products 6
Test Your In-App Purchase Products 6
Submit Your In-App Purchase Products for Review 6
Manage the In-App Purchase Products Available in Your App 6
Prerequisites 6
See Also 7
Contents
Deleting Products 30
Tables
Introduction
In-App Purchase is an Apple technology that allows your users to purchase content and services from within
your app. You set up In-App Purchase products through iTunes Connect, a suite of web-based tools. You
implement In-App Purchase in your app using the Store Kit framework.
For example, you can use In-App Purchase to implement any of the following scenarios:
A book reader app that allows the user to purchase and download new books
After youve designed one or more products to make available in your app, youre ready to add In-App Purchase
configuration information in iTunes Connect.
If you arent already familiar with In-App Purchase, read Getting Started with In-App Purchase on iOS and OS
X and Adding In-App Purchase to your iOS and Mac Applications. If you arent already familiar with iTunes
Connect, read iTunes Connect Developer Guide .
Introduction
At a Glance
At a Glance
Use iTunes Connect to add, set up testing for, submit, and manage your In-App Purchase product configurations.
Prerequisites
To configure In-App Purchase content in iTunes Connect, you need access to:
Introduction
See Also
See Also
As you include In-App Purchase products in your apps, you may want to refer to these additional Apple
resources, which describe the associated business and development guidelines and requirements:
Getting Started with In-App Purchase on iOS and OS X provides an overview of In-App Purchase marketing
strategies and business requirements.
Adding Capabilities in App Distribution Guide in App Distribution Guide explains how to use Xcode to
enable Apple services such as In-App Purchase.
In-App Purchase Programming Guide describes using the Store Kit framework to embed a store inside your
app.
In-App Purchase for Developers lists the references available to support you through development of your
app and In-App Purchase content.
iTunes Connect Developer Guide contains general information about creating an iTunes Connect record
for your app to submit it to the App Store or the Mac App Store. In addition, this document describes
other steps youll need to complete to market your app, including setting up your organizations contracts
and banking information and submitting app metadata, including artwork and localization information.
It continues with information on how to monitor your apps success.
Throughout this document, look for links to additional documents on more specific topics.
In-App Purchase lets you sell a variety of virtual items directly within your free or paid app. This chapter describes
the In-App Purchase product types and shows you how to configure them in iTunes Connect.
Product type
Description
Consumable
Products that are used one time, after which they become depleted and need to
be purchased again, are usually implemented as consumables. For example, fish
food in a fishing app could be implemented as a consumable product.
Non-Consumable
Auto-Renewable
Subscription
Product type
Description
Free Subscription
Non-Renewing
Subscription
Non-renewing subscriptions allow the sale of items with a limited duration. They
are used for products that offer time-based access to static content.
Configuring a Product
For each app, you can create up to 1000 separate In-App Purchase products. Every product you want to offer
in your store must be configured in iTunes Connect. Because In-App Purchase products are associated with a
single app, you create them from the App Details page in iTunes Connect.
As an iTunes Connect user with an Admin or Technical role, sign in to iTunes Connect.
2.
3.
Apple ID. Enter the Apple ID of the app. This value must match exactly to return an app.
If no apps are listed, then the criteria you type match no apps.
4.
In the search results, clicking the name of an app opens the App Details page.
On the App Details page, click In-App Purchases. This tab is visible only if your iTunes Connect account
has an Admin or Technical role and your team agent has agreed to the latest iOS Developer Program
or Mac Developer Program license agreement.
5.
6.
In the section for the type of In-App Purchase you want to create, click Select.
The In-App Purchase product type cannot be changed once your In-App Purchase has been created.
7.
In the Reference Name field, enter an internal name for the product.
8.
9.
10
In iTunes Connect, you identify the In-App Purchase product using a string called a product identifier .
For example, com.company.app_name.productid. When your app uses Store Kit to communicate
with the App Store, it uses product identifiers to retrieve the configuration data you provided for the
products. Later, when a user wants to purchase a product, your app identifies the product to be
purchased using its product identifier.
Note that product identifiers are unique to the app. For example, you need separate identifiers for
products available from the Mac version of an app and for products available from the iOS version of
an app.
10. Specify whether the product is cleared for sale.
Select Yes if you want the product to be available as soon as it is approved by Apple.
You can come back to this item at any time to release the product for sale.
11. Choose a price tier.
The price tier determines both the customer price and your proceeds (which is the net price after taxes,
where applicable, have been taken out). The Price Tier menu doesnt appear for free subscriptions.
12. Configure the product display text for at least one language, as described in Displaying Products in
This screenshot is used for Apples review only and is not displayed on the App Store.
Screenshots must be at least 640 x 920 pixels and at least 72 dpi.
15. Click Save.
Your In-App Purchase product appears on the apps In-App Purchases page. If the product is Ready to
Submit, the products configuration is complete and ready for you to test the product with your app.
11
This example of a Manage App Subscriptions page on a users device shows six different durations configured
for the subscription. Users can see when a subscription renews (and for how much) and can turn off auto-renewal.
If you configure more than one duration for a subscription, users can select among the different durations for
the renewal.
All six subscription durations were created within the same family in the In-App Purchase product in iTunes
Connect. Subscriptions created in different duration families appear as separate products and are not offered
to customers as alternatives for subscription renewal.
When their subscription renewal date approaches, customers are notified if the price of an auto-renewable
subscription has increased. After their subscriptions expire, they are opted-out of the subscription and must
manually renew their subscription at the increased price.
If the price of an auto-renewable subscription decreases during the subscription period, customers are not
notified and the subscription automatically renews at the lower price.
Table 1-2 (page 13) describes the options you have to design different duration and price combinations to
offer your customers.
12
Table 1-2
Property
Description
Duration
The length of time between auto-renewals. Each duration can be used only once
per product family. The duration can be 7 days, 1 month, 2 months, 3 months, 6
months, or 1 year.
Offer a marketing
opt-in incentive
An amount of time where the content is provided at no cost after which users
are automatically renewed for the subscription, unless users turn off auto-renewal.
The free trial begins when the user subscribes. You can set the duration of the
incentive to be a subset of this subscription duration.
Price Tier
The price tier at which you want to sell the subscription for this duration.
13
After confirming the purchase, users sign in to their App Store account, if they arent already signed in. If the
product is configured with an opt-in incentive, the personal data sharing dialog appears, asking users to choose
to share their information with you. The prompt includes the opt-in incentive duration. Users can select Don't
Allow in this dialog and still purchase the subscription.
After users purchase the subscription, they receive a subscription confirmation email with information regarding
the subscription they have purchased. The display name that you choose for your In-App Purchase product
(as appropriate for this users territory) appears in the confirmation email as the Name of Subscription.
14
Create a new non-consumable product, as described in To create an In-App Purchase product (page
9).
Alternatively, open the In-App Purchase page for an existing non-consumable product.
2.
In the In-App Purchase Details section, Hosting Content with Apple area, select Yes.
3.
Click Save.
If you accidentally enable Hosting Content with Apple, you can undo this selection by deleting the In-App
Purchase product and re-configuring it. Note that you cant use the same product ID when you re-create the
product.
15
Open the App Details page for the app with subscriptions.
2.
3.
4.
You can access the In-App Purchase Shared Secret page from inside the In-App Purchases page for an app or
from the Ellipsis () menu in the upper left corner of the My Apps page. This link is visible if you have at least
one auto-renewable subscription set up for any app.
16
17
iTunes Connect configures an In-App Purchase product and its display text separately. This separation allows
you to provide text for each language or territory your app supports. You must provide at least one language
configuration for each product. See Language Properties (page 37) for specific requirements of product
language properties.
If you havent already created an In-App Purchase product, do so as described in To create an In-App
Purchase product (page 9).
2.
3.
In the Language section of the product summary page, click Add Language.
4.
5.
In the Display Name field, enter a localized name for the In-App Purchase product.
For example, if you choose Finnish from the Language menu, enter the Finnish name for the In-App
Purchase product in the Display Name field.
6.
In the Description field, enter a localized description of the In-App Purchase product.
For auto-renewable subscriptions, make sure that you dont include duration information in the
description.
7.
If the In-App Purchase product is an auto-renewable or free subscription, enter the title of your
subscription in the Publication Name field.
The publication name can be the same as your app name or the same as the display name set in step
5. Dont include version, platform, or duration information.
18
8.
Click Save.
From here, you can continue with the In-App Purchase product registration or repeat the steps to add
display text for an additional language.
19
You can test your app and In-App Purchase products without creating financial transactions. Thats because
Apple provides a test environment that uses the infrastructure of the App Store but that doesnt process actual
payments. Using iTunes Connect test user accounts, it instead returns transactions as if payments were processed
successfully.
For more information about what tests to perform, see Suggested Testing Steps in In-App Purchase Programming
Guide .
Set up test user accounts within Users and Roles in iTunes Connect, as detailed in Creating Sandbox
Tester Accounts in iTunes Connect Developer Guide .
Youll need a test user for each territory you want to test the app in.
2.
Important: Dont enter your test account information in the Store settings panel. Doing so may
invalidate your test account.
3.
4.
5.
Open your app, and perform your In-App Purchase product testing.
6.
20
When your app uses the Store Kit API to request a payment, youre asked to sign in. Select Use Existing
Account and enter your test account user name and password. You are then asked to confirm the
purchase. The transaction completes.
No financial transaction takes place, but a receipt is generated for a successful transaction.
Actual duration
Test duration
1 week
3 minutes
1 month
5 minutes
2 months
10 minutes
3 months
15 minutes
6 months
30 minutes
1 year
1 hour
21
After you create In-App Purchase products in iTunes Connect, you submit them to Apple for review.
Configure your In-App Purchase product until its status is Ready to Submit.
See Configuring a Product (page 9).
2.
On the App Details page, select the version of your app that you are about to release and scroll down
to the In-App Purchases section, just below the Builds section.
3.
22
4.
Choose which In-App Purchase products you want to submit with this version of your app.
5.
Click Done.
The In-App Purchase products you chose are listed in the In-App Purchases section.
6.
If you have configured everything you need for this app, click Submit For Review.
To submit an In-App Purchase product for an app that is available on the store
1.
2.
23
The In-App Purchases page displays all products configured for this app.
3.
Make any needed changes until all products have the status Ready to Submit.
In the product page, click anywhere in a product row to open a product you want to release. See
Working with Your Products Metadata (page 31).
4.
5.
6.
Click Done in the product page to return to the In-App Purchases page.
7.
To release more than one product for review at once, select the products from the In-App Purchases
page list and click Submit for Review.
24
Use the Select All and Deselect All buttons and select or deselect individual products.
The status of the In-App Purchase products changes from "Ready to Submit" to "Waiting for Review".
25
After you create an In-App Purchase product record in iTunes Connect, the product appears in the In-App
Purchases page for the app. This chapter describes the status values used to describe the state of the products
and shows you how to change a products status, its availability on the store, and its pricing.
To manage In-App Purchase products, you must be signed in to iTunes Connect as a user with an Admin or
Technical role.
, or
). The status tells you immediately whether your product needs attention.
A red status indicator means that you need to perform some action before an product can be available.
A yellow status indicator means that some process is ongoing, either controlled by you or by Apple.
Read the version status text in Table 5-1 (page 26) to understand what may be preventing your product from
being available. This table lists every available status that can be assigned to your In-App Purchase.
Table 5-1
Status
Description
Waiting for
Screenshot
Your In-App Purchase product has been created, but you have not yet
uploaded a screenshot.
Ready to Submit
You have uploaded all the metadata needed for the product, but you
have not yet sent it to Apple for review.
The product must have this status to be associated with an app version
release, as described in To submit the first In-App Purchase product
for an app (page 22). After testing the product, you can submit it for
review.
26
Status
Status Name
Description
Waiting for
Upload
Your In-App Purchase product content has not been uploaded yet.
This status only applies to non-consumable products that are set to
be hosted by Apple.
Processing
Content
Waiting For
Review
In Review
Approved
Apple has approved your In-App Purchase to go live on the App Store
with its associated app.
For this status to appear, the In-App Purchase must be cleared for sale
in iTunes Connect. If it is not cleared for sale, the status appears as
Developer Removed from Sale.
If the product is being released with an app version, the product wont
have an Approved status until the app is approved.
Rejected
Apple has rejected your In-App Purchase product during the review
process. If you have not already been contacted by Apple with more
information about your rejection, you can inquire through the Contact
Us module of iTunes Connect.
You have the option to cancel the change or make additional edits to
the details to be compliant with Apple guidelines. Your In-App
Purchase product status changes to Developer Action Needed if there
is a detail in the In-App Purchase that requires a change by you.
Developer Action
Needed
The In-App Purchase product changes that you submitted have been
rejected. You are required to take action to edit the detail information
or cancel the request to change the detail information before this
In-App Purchase can be reviewed again.
Developer
Removed from
Sale
You have marked your In-App Purchase as not cleared for sale in iTunes
Connect.
Removed from
Sale
If you clear the product for sale, the status changes to Approved.
27
Go to the In-App Purchases page for the app, as described in To view In-App Purchase product
configuration information (page 32).
2.
Click in the row of the In-App Purchase product you want to edit.
3.
4.
5.
If you want to replace the existing Price Tier, select the new Price Tier, then set the Price Effective
Date to Now and the Price End Date to None. Click Add to Schedule.
If you want to have the product price change at some date in the future, select the future Price
Tier, then set the Price Effective Date and Price End Date to define the interval for the new price.
Click Add to Schedule.
Click Save.
The new values appear in the In-App Purchase Summary and are effective immediately. Apple doesnt
review these changes.
28
Important: Removing a product from sale prevents auto-renewable subscriptions from renewing, but it
doesnt keep users from being able to restore products that they purchased previously.
Open the In-App Purchases page for the app, as described in To view In-App Purchase product
configuration information (page 32).
2.
Click in the row of the In-App Purchase product you want to remove.
3.
4.
5.
Click Save.
The status of the In-App Purchase product changes to Developer Removed from Sale. Users wont see
this product for sale through the app.
29
Follow the instructions To remove an In-App Purchase product from sale (page 29) but set Cleared for
Sale to Yes.
The status of the In-App Purchase product changes to Approved, and the product is available for users
to purchase through the app.
Deleting Products
You can delete In-App Purchase products after theyre created, but not if theyre In Review. To delete a product
after it is available for sale, you must first remove it from sale. See Removing Products from Sale (page 28).
Important: After you delete an In-App Purchase product, its no longer available on iTunes Connect and
it cant be restored. The product ID cant be reused for another In-App Purchase product.
Remove the In-App Purchase product from sale, as described in Removing Products from Sale (page
28).
2.
3.
30
You can change anything in a products metadata except the Product ID and type. Some changes require
review by Apple.
Changes before submission. If your In-App Purchase product has never been submitted to Apple for
review, you can make changes to the product details.
Reference Name. You can change the product reference name at any time without review.
Display Name and Description. Changes to the localized product descriptions require review. The existing
text displays on the store until the new text is approved. The change has its own status separate from the
overall status of the In-App Purchase product. Before it is reviewed, you can revert the change.
New Language Support. Because language settings are independent of one another, you can add and
remove languages as needed. Text in new languages are reviewed individually. After a product is submitted,
changes to localized text or new language support have their own status separate from the overall status
of the In-App Purchase product.
Screenshot. A product must have a review screenshot in place for submission; after you upload a screenshot,
you can replace it with another, but you cant remove it. You cant change the screenshot while the product
is in review. You can update the screenshot if the product is rejected.
Hosting Content with Apple. You can change a product to be hosted by Apple before you submit the
product for review.
To manage In-App Purchase products, you must be signed in to iTunes Connect as a user with an Admin or
Technical role.
To make changes that affect the products status, pricing, availability instead of its metadata, see Working with
Your Products Status (page 26).
31
As an iTunes Connect user with an Admin or Technical role, sign in to iTunes Connect.
2.
3.
4.
This tab is visible only if your iTunes Connect account has an Admin or Technical role and your team
agent agreed to the latest iOS Developer Program or Mac Developer Program license agreement.
The In-App Purchases page opens.
5.
Click in the row of the In-App Purchase product you want to view.
The In-App Purchases page lists the products defined for this app and their status.
32
Click Create New to configure a new In-App Purchase product for the app, as described in Configuring a
Product (page 9).
Click in the row of an existing In-App Purchase product to edit the product information, as described in
Changing Product Display Text (page 34).
Select In-App Purchase products and click Submit for Review to release multiple products at once, as
described in Submitting In-App Purchase Products (page 23).
Open the In-App Purchases page for the app, as described in To view In-App Purchase product
configuration information (page 32).
2.
Click in the row of the In-App Purchase product you want to edit.
3.
4.
5.
Click Save.
The new values appear in the In-App Purchase Details section and are effective immediately.
33
Open the In-App Purchases page for the app, as described in To view In-App Purchase product
configuration information (page 32).
2.
3.
In the product page, click in the row for the language you want to edit.
4.
If the product is already approved when you make changes, youll see the status of the display text in a new
language (or a change to display text in an existing language). The changes to an existing language are shown
separately from the approved text.
34
In the product page, changes to an existing language or new languages are marked as pending changes.
Open the In-App Purchases page for the app, as described in To view In-App Purchase product
configuration information (page 32).
2.
3.
In the product page, in the row for the language you want to delete, click Delete.
4.
35
This appendix describes the metadata that iTunes Connect collects to configure the interface between a version
of your app and In-App Purchase servers and to display product information in the App Store. You set these
properties in the product page of the In-App Purchases page for an app, as described in Creating In-App
Purchase Products (page 8) and Working with Your Products Metadata (page 31).
Product Properties
The main In-App Purchase product properties identify the product in iTunes Connect and in the app.
Property
Description
Apple ID
Reference
Name
The products reference name is displayed in iTunes Connect and in Sales and Trends
reports. It isnt displayed on the App Store. The reference name can include any
characters and can be as long as 255 bytes, assuming single-byte characters.
The reference name is editable at any time and must be unique within the app.
Product ID
The globally unique UTF-8 alphanumerical identifier for the product. The Product ID
is any sequence of letters and numbers that uniquely identify the product. It can
include periods and underscores and can be as long as 255 bytes, assuming single-byte
characters. This value is used in the app to identify the product. It cant be used for
more than one product or the same product on Mac apps and iOS apps.
We recommend that you use the reverse domain name style (for example,
com.companyname.application.productid) when creating your Product ID.
The Product ID is not editable after you save the product record. After you use a
Product ID for one product, it can't be used again, even if the product is deleted.
For more information, see In-App Purchase Product Identifiers.
36
Property
Description
Type
The type of In-App Purchase product. The type can be one of the following:
Consumable
Non-Consumable
Free Subscription
Non-Renewing Subscription
Auto-Renewable Subscription
Status
Review Notes
Additional information about the product that might help Apple review its submission,
such as test user accounts and passwords. Review notes should not exceed 4000 bytes.
Screenshot
A screenshot of the product as it appears on the device. This screenshot is used for
Apples review only and is not displayed on the App Store.
Screenshots must be at least 640 x 920 pixels and at least 72 dpi.
Language Properties
In-App Purchase product language properties collect language-specific text used in product display. You must
include these properties for at least one language.
Property
Description
Language
Display Name
The name of the product that is displayed to users. The display name must be at
least two characters and no more than 75 bytes, assuming single-byte characters.
Description
37
Property
Description
Publication Name
The title of your In-App Purchase subscription. This may be the same as your app
name or display name but should not include version, platform, or duration
information. The publication name can be as long as 30 characters, assuming
single-byte characters.
The publication name only applies to auto-renewable and free subscriptions.
Description
Price Tier
A price tier associated with the product. Only available pricing options appear
in the Price Tier menu when you create or edit pricing for a product. Click
View Pricing Matrix under the Price Tier menu to see price tier values in each
currency.
The date when the price tier becomes valid. The price tier is current if this
value is Now.
The date that a price tier is no longer be in effect. The price tier is the last
tier scheduled if this value is None.
Duration Properties
These properties describe the time durations for subscriptions, including subscription extensions such as free
trials and opt-in incentives. See To generate a shared secret (page 16).
Property
Description
Auto-Renewable
Duration
38
Property
Description
The length of time of the free trial, if a free trial is configured for this product.
Free trials are available only for auto-renewable subscriptions.
Marketing Incentive
Duration
39
This table describes the changes to In-App Purchase Configuration Guide for iTunes Connect .
Date
Notes
2014-10-02
Updates to UI.
2013-12-12
40
Apple Inc.
Copyright 2014 Apple Inc.
All rights reserved.
No part of this publication may be reproduced,
stored in a retrieval system, or transmitted, in any
form or by any means, mechanical, electronic,
photocopying, recording, or otherwise, without
prior written permission of Apple Inc., with the
following exceptions: Any person is hereby
authorized to store documentation on a single
computer or device for personal use only and to
print copies of documentation for personal use
provided that the documentation contains
Apples copyright notice.
No licenses, express or implied, are granted with
respect to any of the technology described in this
document. Apple retains all intellectual property
rights associated with the technology described
in this document. This document is intended to
assist application developers to develop
applications only for Apple-branded products.
Apple Inc.
1 Infinite Loop
Cupertino, CA 95014
408-996-1010
Apple, the Apple logo, iTunes, Mac, Mac OS, OS
X, Sand, and Xcode are trademarks of Apple Inc.,
registered in the U.S. and other countries.
App Store and Mac App Store are service marks
of Apple Inc.
IOS is a trademark or registered trademark of
Cisco in the U.S. and other countries and is used
under license.
APPLE MAKES NO WARRANTY OR REPRESENTATION,
EITHER EXPRESS OR IMPLIED, WITH RESPECT TO THIS
DOCUMENT, ITS QUALITY, ACCURACY,
MERCHANTABILITY, OR FITNESS FOR A PARTICULAR
PURPOSE. AS A RESULT, THIS DOCUMENT IS PROVIDED
AS IS, AND YOU, THE READER, ARE ASSUMING THE
ENTIRE RISK AS TO ITS QUALITY AND ACCURACY.
IN NO EVENT WILL APPLE BE LIABLE FOR DIRECT,
INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES RESULTING FROM ANY DEFECT, ERROR OR
INACCURACY IN THIS DOCUMENT, even if advised of
the possibility of such damages.
Some jurisdictions do not allow the exclusion of
implied warranties or liability, so the above exclusion
may not apply to you.