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” and “Working with Your Product’s Metadata.”

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 product’s reference name is displayed in iTunes Connect and in Sales and Trends reports. It isn’t 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 can’t 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.

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 Apple’s 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.

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 product’s iTunes Connect record is created. See “Working with Your Product’s Metadata.”

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

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.

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

Note that Free Subscriptions can’t 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.