You are on page 1of 41

In-App Purchase

Configuration Guide for


iTunes Connect

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

Creating In-App Purchase Products 8


About In-App Purchase Products 8
Configuring a Product 9
Designing Auto-Renewable Subscription Duration Families 11
What Users See After Purchasing an Auto-Renewable Subscription 13
Hosting Non-Consumable Products with Apple 14
Verifying an Auto-Renewable Subscription Receipt 15
Providing Access to Privacy Policies for Subscriptions 17

Displaying Products in More Than One Language 18


Testing In-App Purchase Products 20
Testing Your App and In-App Purchase Products 20
Testing Auto-Renewable Subscriptions 21

Submitting In-App Purchase Products 22


Submitting Your First In-App Purchase Product 22
Submitting In-App Purchase Products 23

Working with Your Products Status 26


About In-App Purchase Product Statuses 26
Changing Product Pricing 28
Controlling Product Availability 28
Removing Products from Sale 28
Returning Products to Sale 29

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

Contents

Deleting Products 30

Working with Your Products Metadata 31


Viewing Your Products Metadata 31
Changing Your Products Metadata 33
Accessing Product Sales and Download Reports 33
Changing Review Notes, Screenshot, Hosting Content 33
Changing Product Display Text 34
Deleting Product Display Text 35

Properties of In-App Purchase Metadata 36


Product Properties 36
Language Properties 37
Pricing and Availability Properties 38
Duration Properties 38

Document Revision History 40

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

Tables

Creating In-App Purchase Products 8


Table 1-1
Table 1-2

In-App Purchase product types 8


Auto-renewable subscription pricing and duration options 13

Testing In-App Purchase Products 20


Table 3-1

Subscription durations for testing 21

Working with Your Products Status 26


Table 5-1

In-App Purchase product statuses 26

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

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 basic version of your app with additional premium features

A book reader app that allows the user to purchase and download new books

A game that offers new environments (levels) to explore

A game that allows players to purchase virtual property

An app that provides access to a turn-by-turn map service

A subscription to a digital magazine or newsletter

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 .

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

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.

Configure Your In-App Purchase Products


After youve created an iTunes Connect record for your app, you can configure the In-App Purchase products
that you want to make available through your app.
Related Chapters: Creating In-App Purchase Products (page 8), Displaying Products in More Than
One Language (page 18)

Test Your In-App Purchase Products


Test the In-App Purchase products youve configured to make sure they appear in your apps store and to
make sure that financial transactions work properly.
Related Chapters: Testing In-App Purchase Products (page 20)

Submit Your In-App Purchase Products for Review


After youve included all the information for a product and tested to make sure it appears in your apps store,
you are ready to submit the product for review and to make it available on the store.
Related Chapters: Submitting In-App Purchase Products (page 22)

Manage the In-App Purchase Products Available in Your App


After an In-App Purchase product is approved and ready for sale, you can continue to manage its display,
pricing, and availability on the store.
Related Chapters: Working with Your Products Status (page 26), Working with Your Products
Metadata (page 31)

Prerequisites
To configure In-App Purchase content in iTunes Connect, you need access to:

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

Introduction
See Also

The latest iOS or Mac Developer Program License Agreement


See Legal Agreements in Your Account in Member Center.

The latest paid app contract, either iOS or Mac


Open the Agreements, Tax, and Banking module in iTunes Connect, as described in Managing Agreements,
Tax, and Banking in iTunes Connect Developer Guide in iTunes Connect Developer Guide .

An iTunes Connect user account with an Admin or Technical role


See Setting Up User Accounts in iTunes Connect Developer Guide in iTunes Connect Developer Guide .

An iTunes Connect record for your app


See Creating an iTunes Connect Record for an App in iTunes Connect Developer Guide in iTunes Connect
Developer Guide .

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

Creating In-App Purchase Products

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.

About In-App Purchase Products


Read Table 1-1 (page 8) to know how to choose among the different product types to offer your virtual
content or service to customers.
For more information about development considerations for each product type, see Designing Your Apps
Products in In-App Purchase Programming Guide .
Table 1-1

In-App Purchase product types

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

Non-consumable products are purchased once by users and do not expire or


decrease with use. For example, new race tracks for a game could be implemented
as non-consumable products.
Apple can host your non-consumable products for you. See Hosting
Non-Consumable Products with Apple (page 14).

Auto-Renewable
Subscription

Auto-renewable subscriptions allow users to purchase dynamic content, such as


magazine subscriptions, for a set duration of time. Subscriptions renew
automatically unless the user opts out of the renewal. If the content you want
offer doesnt fit whats outlined in the App Review Guidelines, consider offering
the content through a non-renewing subscription.
Auto-renewable subscriptions can include an incentive to customers who share
their contact information with you.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

Creating In-App Purchase Products


Configuring a Product

Product type

Description

Free Subscription

Free subscriptions allow users to download dynamic content, such as magazine


subscriptions, for a set duration of time. Free subscriptions are a way for developers
to put free content in the Newsstand in the App Store. After a user signs up for a
free subscription, the subscription content will be available on all devices
associated with the users Apple ID. Note that free subscriptions do not expire
and can be offered only in Newsstand-enabled apps.
Free subscriptions dont offer a marketing opt-in incentive as do auto-renewable
subscriptions, but users are prompted to share their information.
Free Subscriptions are not available for Mac apps.

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.

If you use non-renewing subscriptions, your app is responsible for delivering


the subscription to all devices associated with the users Apple ID.

Because a non-renewing subscription requires a user to renew each time the


subscription ends, your app must contain code that recognizes when the
subscription is due to expire and prompt the user to purchase a new
subscription.

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.

To create an In-App Purchase product


1.

As an iTunes Connect user with an Admin or Technical role, sign in to iTunes Connect.

2.

On the iTunes Connect homepage, click My Apps.

3.

Select the app you want to enable In-App Purchase for.


If you don't see the app you are looking for on the My Apps page, you can search for the app using a
variety of criteria. In the Search box, choose the criteria you want to use to search for an app. The view
starts filtering the list of apps as soon as you start typing:

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

Creating In-App Purchase Products


Configuring a Product

Name. Enter the name or a portion of the name.

Apple ID. Enter the Apple ID of the app. This value must match exactly to return an app.

SKU. Enter the SKU of the 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.

In the In-App Purchases page, click Create New.

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.

For auto-renewable subscriptions, click Add Duration.


For information on designing subscription durations, see Designing Auto-Renewable Subscription
Duration Families (page 11).

9.

In the Product ID field, enter an alphanumeric identifier for the product.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

10

Creating In-App Purchase Products


Designing Auto-Renewable Subscription Duration Families

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.

Select No if you want to control when the product becomes available.

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

More Than One Language (page 18).


13. In the Review Notes section, enter information that can help Apple review the product.
14. Upload 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.
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.

Designing Auto-Renewable Subscription Duration Families


You can think of subscription durations as individual products, each with its own time length, price, and
marketing incentives. You define durations in a single family to allow users to choose among the durations
when they renew their subscription. Start a new auto-renewable subscription and define durations in a different
family to make distinct subscription products.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

11

Creating In-App Purchase Products


Designing Auto-Renewable Subscription Duration Families

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

12

Creating In-App Purchase Products


What Users See After Purchasing an Auto-Renewable Subscription

Table 1-2

Auto-renewable subscription pricing and duration options

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 additional amount of time added to the initial subscription when customers


choose to share their contact information with you. You can set the duration of
the incentive to be the same length as the subscription duration or shorter. There
is no charge added for the additional time.
Contact information from users who opt in is available in the Sales and Trends
module of iTunes Connect.
Note: The opt-in incentive is not available for Mac OS X.

Offer a Free Trial

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.

What Users See After Purchasing an Auto-Renewable Subscription


After users purchase an auto-renewable subscription, they see a Confirm Your Subscription dialog. The
confirmation includes the subscriptions display name and its duration:

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

13

Creating In-App Purchase Products


Hosting Non-Consumable Products with Apple

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.

Hosting Non-Consumable Products with Apple


Apple can host your non-consumable products for you. Apple provides a reliable and familiar experience for
users and handles distributing products to their devices and restoring products if needed.
When you host content with Apple, Apple stores your apps content using the same infrastructure that supports
other large-scale operations, such as the App Store. Additionally, Apple automatically downloads Apple-hosted
content in the background even if your app isnt running.
You can choose to have Apple host In-App Purchase products when you first create the products in iTunes
Connect. You can also convert content that you are currently hosting on your own servers to be hosted by
Apple.
To host content with Apple, you submit the content to Apple for review. You create a product in Xcode using
a In-App Purchase Content template, include your content, and upload it to iTunes Connect using the Archive
process. Alternatively, you can create a .pkg file from Xcode for each product and upload them all at once
using Application Loader. See Using Application Loader more information about submitting In-App Purchase
metadata and content to iTunes Connect.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

14

Creating In-App Purchase Products


Verifying an Auto-Renewable Subscription Receipt

To enable content hosting


1.

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.

Verifying an Auto-Renewable Subscription Receipt


To increase the security of the transaction between your app and Apples servers when validating an
auto-renewable subscription, you can include a string of 32 randomly generated alphanumeric characters in
the transaction receipt. Generate this parameter, known as the shared secret, in iTunes Connect.
For information about incorporating the shared secret into your apps receipt handling, see Receipt Validation
Programming Guide .
There is only one shared secret per organization; make sure that when you generate a new shared secret, all
apps submitted for your organization use the new value to verify auto-renewable subscriptions.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

15

Creating In-App Purchase Products


Verifying an Auto-Renewable Subscription Receipt

To generate a shared secret


1.

Open the App Details page for the app with subscriptions.

2.

Click In-App Purchases.

3.

Click "View or generate a shared secret".

4.

In the In-App Purchase Shared Secret page, click Generate.

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

16

Creating In-App Purchase Products


Providing Access to Privacy Policies for Subscriptions

Providing Access to Privacy Policies for Subscriptions


If your app collects user or device-related data, iTunes Connect asks for a URL linking to a privacy policy that
applies to your app. Privacy policy URLs are required for apps that offer auto-renewable or free subscriptions
or as required by law. Supply a privacy policy in each language in which your app displays on the App Store.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

17

Displaying Products in More Than One Language

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.

To add display text for an In-App Purchase product


1.

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.

Choose the In-App Purchase product type.

3.

In the Language section of the product summary page, click Add Language.

4.

Choose a language from the Language menu.

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

18

Displaying Products in More Than One Language

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

19

Testing In-App Purchase Products

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 .

Testing Your App and In-App Purchase Products


Use a test user account when you test In-App Purchase products.

To perform testing for In-App Purchase products


1.

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.

Clear any account information stored on your test device.

In Settings, go to the Store settings.

Click the Sign Out button.


This prevents an actual user account from automatically being used when testing.

Important: Dont enter your test account information in the Store settings panel. Doing so may
invalidate your test account.
3.

Connect your test device to your Mac.

4.

In Xcode, set your test device as your schemes destination.

5.

Open your app, and perform your In-App Purchase product testing.

6.

Use your test account credentials to test the purchase.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

20

Testing In-App Purchase Products


Testing Auto-Renewable Subscriptions

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.

Testing Auto-Renewable Subscriptions


When testing auto-renewable subscriptions in the test environment, keep in mind that the duration times are
compressed. Additionally, test subscriptions only auto-renew a maximum of six times. Table 3-1 (page 21) lists
the compressed duration times.
Table 3-1

Subscription durations for testing

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

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

21

Submitting In-App Purchase Products

After you create In-App Purchase products in iTunes Connect, you submit them to Apple for review.

Submitting Your First In-App Purchase Product


You submit your first In-App Purchase product when you submit an app version for review.
Important: To associate In-App Purchase products with the release of your app, make sure its status is
Prepare for Submission.

To submit the first In-App Purchase product for an app


1.

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.

In the In-App Purchase section, click the plus sign.


If you don't see this section, it may mean that the app version doesnt have Prepare for Submission
status.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

22

Submitting In-App Purchase Products


Submitting In-App Purchase Products

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.

Submitting In-App Purchase Products


After an app is available on the store with existing In-App Purchase products, you can submit additional In-App
Purchase products for that app at any time.

To submit an In-App Purchase product for an app that is available on the store
1.

Open App Details for the app.

2.

Select In-App Purchases.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

23

Submitting In-App Purchase Products


Submitting In-App Purchase Products

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.

Click Submit for Review.


The In-App Purchase product must have the status Ready to Submit for this button to be available.

5.

Click Submit to confirm the submission.


The status of the In-App Purchase products change to Waiting for Review.

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

24

Submitting In-App Purchase Products


Submitting In-App Purchase Products

Use the Select All and Deselect All buttons and select or deselect individual products.

Click Submit to confirm the submission.

The status of the In-App Purchase products changes from "Ready to Submit" to "Waiting for Review".

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

25

Working with Your Products Status

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.

About In-App Purchase Product Statuses


Just like apps, In-App Purchase products are marked with a status. This status indicates where the products
are in the process of making them available for purchase or download.
In-App Purchase products have statuses such as "Ready to Submit" or "Approved" ) or a status indicator (such
as

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

A green status indicator means that the product is available.

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

In-App Purchase product statuses


Status Name

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

26

Working with Your Products Status


About In-App Purchase Product Statuses

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

Your In-App Purchase product content delivery is processing.

Waiting For
Review

You have submitted your In-App Purchase product to be reviewed by


Apple.
You can make edits to the product while it is in this status.

In Review

Your In-App Purchase product is currently being reviewed by Apple.


Only edits to the products reference name, pricing, and availability
can be made when it has this status.

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

Appears when Apple removes an In-App Purchase product from sale.

If you clear the product for sale, the status changes to Approved.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

27

Working with Your Products Status


Changing Product Pricing

Changing Product Pricing


You can change the pricing for an In-App Purchase product at any time.

To change product pricing


1.

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.

In the In-App Purchase Summary section, click Edit.

4.

Make changes to the summary information.

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.

Controlling Product Availability


In-App Purchase products are available worldwide and arent limited by territory. This availability ensures a
seamless customer experience. For example, if an app is purchased in Germany and the customer moves to
Turkey, the customer can still access products within the app even if the app has never been available in Turkey.
If you need to restrict product access for some reason, you develop a solution from inside the app.

Removing Products from Sale


You can choose to stop an In-App Purchase product from being sold in an app. If you do, the In-App Purchase
product remains in iTunes Connect.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

28

Working with Your Products Status


Controlling Product Availability

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.

To remove an In-App Purchase product from sale


1.

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.

In the In-App Purchase summary section, click Edit.

4.

Set Cleared for Sale to No.

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.

Returning Products to Sale


After youve removed an In-App Purchase product from sale through your app, you can return it to sale if you
want.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

29

Working with Your Products Status


Controlling Product Availability

To return an In-App Purchase product to sale

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.

To delete an In-App Purchase


1.

Remove the In-App Purchase product from sale, as described in Removing Products from Sale (page
28).

2.

In the products configuration page, click Delete.

3.

Click Delete to confirm.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

30

Working with Your Products Metadata

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

Viewing Your Products Metadata


In-App Purchase products are organized inside their apps iTunes Connect record. You view the In-App Purchase
products for an app from the App Details page.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

31

Working with Your Products Metadata


Viewing Your Products Metadata

To view In-App Purchase product configuration information


1.

As an iTunes Connect user with an Admin or Technical role, sign in to iTunes Connect.

2.

On the iTunes Connect homepage, click My Apps.

3.

Select the app you want to configure In-App Purchase for.

4.

On the App Details page, select In-App Purchases.

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

32

Working with Your Products Metadata


Changing Your Products Metadata

Changing Your Products Metadata


From the In-App Purchases page, you can do the following:

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

Accessing Product Sales and Download Reports


The Sales and Trends module in iTunes Connect provides information about how many times an In-App
Purchase has been purchased or downloaded. See Viewing Sales and Trends in iTunes Connect Developer Guide
in iTunes Connect Developer Guide .

Changing Review Notes, Screenshot, Hosting Content


You can change Review Notes, Screenshot for Review, and Hosting Content with Apple for an In-App Purchase
product before the product is submitted. You can change the Reference Name for a product at any time.

To change product details


1.

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.

In the In-App Purchase Details section, click Edit.


If the Edit button doesnt appear, its because the product has a status that does not allow editing.

4.

5.

Make changes to the summary information.

For non-consumable products, change whether the content is hosted by Apple.

Enter review notes.

Click Choose File to upload or replace a review screenshot.

Click Save.
The new values appear in the In-App Purchase Details section and are effective immediately.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

33

Working with Your Products Metadata


Changing Product Display Text

Changing Product Display Text


You can add product display text in new languages (see Displaying Products in More Than One Language (page
18)) or you can edit the text provided in an existing language.

To edit display text for an existing language


1.

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 product you want to edit.

3.

In the product page, click in the row for the language you want to edit.

4.

Make changes in the Edit Language dialog.

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

34

Working with Your Products Metadata


Changing Product Display Text

In the product page, changes to an existing language or new languages are marked as pending changes.

Deleting Product Display Text


You can delete text for an existing language at any time except when the product is in review. At least one
language needs to be configured.

To delete display text for a language


1.

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 product you want to edit.

3.

In the product page, in the row for the language you want to delete, click Delete.

4.

Click Delete to confirm.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

35

Properties of In-App Purchase Metadata

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

The unique Apple ID assigned to the In-App Purchase product.

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.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

36

Properties of In-App Purchase Metadata


Language Properties

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

The current state of the product.

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

The language used by the display name and description.

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

A description of the product that potentially displays to users. The description


must be at least ten characters and no more than 255 bytes, assuming single-byte
characters.
For auto-renewable subscriptions, the description should not include a duration
as there could be more than one duration configured.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

37

Properties of In-App Purchase Metadata


Pricing and Availability Properties

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.

Pricing and Availability Properties


These properties describe when the product is available and at what price. Note that the price tier start and
end dates are available only after the products iTunes Connect record is created. See Working with Your
Products Metadata (page 31).
Property

Description

Cleared for Sale

An indication of whether you want this product to be available to be sold.


If the product is approved by Apple, it can still be held by the developer by
setting Cleared for Sale to No.

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.

Price Tier Effective


Date

The date when the price tier becomes valid. The price tier is current if this
value is Now.

Price Tier End Date

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

The length of time between auto-renewals. The duration can be 7 days, 1


month, 2 months, 3 months, 6 months, or 1 year.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

38

Properties of In-App Purchase Metadata


Duration Properties

Property

Description

Free Trial Duration

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

The length of an auto-renewable subscription extension if customers choose


to opt-in to share contact information.
Users contact information is available in the Sales and Trends module of iTunes
Connect. See Accessing Product Sales and Download Reports (page 33).
Note that Free Subscriptions cant offer a marketing opt-in incentive (because
the subscription is already free), but users are asked if they want to opt-in to
share their information.
Note: The opt-in incentive is not available for Mac OS X.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

39

Document Revision History

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

New document that describes In-App Purchase setup in iTunes Connect.

2014-10-02 | Copyright 2014 Apple Inc. All Rights Reserved.

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.

You might also like