page.title=Administering In-app Billing
parent.title=In-app Billing
parent.link=index.html
@jd:body

<div id="qv-wrapper">
<div id="qv">
  <h2>In this document</h2>
  <ol>
    <li><a href="#billing-list-setup">Creating a Product List</a></li>
    <li><a href="#billing-purchase-type">Choosing a Purchase Type</a></li>
    <li><a href="#billing-testing-setup">Setting up Test Accounts</a></li>
    <li><a href="#billing-refunds">Handling Refunds</a></li>
    <li><a href="#billing-support">Where to Get Support</a></li>
  </ol>
  <h2>Downloads</h2>
  <ol>
    <li><a href="{@docRoot}guide/market/billing/billing_integrate.html#billing-download">Sample
    Application</a></li>
  </ol>
  <h2>See also</h2>
  <ol>
    <li><a href="{@docRoot}guide/market/billing/billing_overview.html">Overview of In-app
    Billing</a></li>
    <li><a href="{@docRoot}guide/market/billing/billing_integrate.html">Implementing In-app
    Billing</a></li>
    <li><a href="{@docRoot}guide/market/billing/billing_best_practices.html">Security and
    Design</a></li>
    <li><a href="{@docRoot}guide/market/billing/billing_testing.html">Testing In-app
    Billing</a></li>
    <li><a href="{@docRoot}guide/market/billing/billing_reference.html">In-app Billing
    Reference</a></li>
  </ol>
</div>
</div>

<p>In-app billing frees you from processing financial transactions, but you still need to perform a
few administrative tasks, including setting up and maintaining your product list on the publisher
site, registering test accounts, and handling refunds when necessary.</p>

<p>You must have an Android Market publisher account to register test accounts. And you must have a
Google Checkout merchant account to create a product list and issue refunds to your users. If you
already have a publisher account on Android Market, you can use your existing account. You do not
need to register for a new account to support in-app billing. If you do not have a publisher
account, you can register as an Android Market developer and set up a publisher account at the
Android Market <a href="http://market.android.com/publish">publisher site</a>. If you do not have a
Google Checkout merchant account, you can register for one at the <a
href="http://checkout.google.com">Google Checkout site</a>.</p>

<h2 id="billing-list-setup">Creating a Product List</h2>

<p>The Android Market publisher site provides a product list for each of your published
applications. You can sell an item using Android Market's in-app billing feature only if the item is
listed on an application's product list. Each application has its own product list; you cannot sell
items that are listed in another application's product list.</p>

<p>You can access an application's product list by clicking the <strong>In-App Products</strong>
link that appears under each of the applications that are listed for your publisher account (see
figure 1). The <strong>In-App Products</strong> link appears only if you have a Google Checkout
merchant account and an application's manifest includes the <code>com.android.vending.BILLING</code>
permission.</p>

<img src="{@docRoot}images/billing_product_list_entry.png" height="548" id="figure1" />
<p class="img-caption">
  <strong>Figure 1.</strong> You can access an application's product list by clicking the
  <strong>In-App Products</strong> link.
</p>

<p>A product list contains information about the items you are selling, such as a product id,
product description, and price (see figure 2). The product list stores only metadata about the items
you are selling in your application. It does not store any digital content. You are responsible for
storing and delivering the digital content that you sell in your applications.</p>

<img src="{@docRoot}images/billing_product_list.png" height="658" id="figure2" />
<p class="img-caption">
  <strong>Figure 2.</strong> An application's product list.
</p>

<p>You can create a product list for any published application or any draft application that's been
uploaded and saved to the Android Market site. However, you must have a Google Checkout merchant
account and the application's manifest must include the <code>com.android.vending.BILLING</code>
permission. If an application's manifest does not include this permission, you will be able to edit
existing items in the product list but you will not be able to add new items to the list. For more
information about this permission, see
<a href="{@docRoot}guide/market/billing/billing_integrate.html#billing-permission">Updating Your
Application's Manifest</a>.</p>

<p>In addition, an application package can have only one product list. If you create a product
list for an application, and you use the <a
href="{@docRoot}guide/market/publishing/multiple-apks.html">multiple APK feature</a> to distribute
more than one APK for that application, the product list applies to all APK versions that are
associated with the application listing. You cannot create individual product lists for each APK if
you are using the multiple APK feature.</p>

<p>You can add items to a product list two ways: you can add items one at a time by using the In-app
Products UI (see figure 3), or you can add a batch of items by importing the items from a
comma-separated values (CSV) file (see figure 2). Adding items one at a time is useful if your
application has only a few in-app items or you are adding only a few items to a
product list for testing purposes. The CSV file method is useful if your application has a large
number of in-app items.</p>

<h3 id="billing-form-add">Adding items one at a time to a product list</h3>

<p>To add an item to a product list using the In-app Products UI, follow these steps:</p>

<ol>
  <li><a href="http://market.android.com/publish">Log in</a> to your publisher account.</li>
  <li>In the <strong>All Android Market listings</strong> panel, under the application name, click
  <strong>In-app Products</strong>.</li>
  <li>On the In-app Products List page, click <strong>Add in-app product</strong>.</li>
  <li>On the Create New In-app Product page (see figure 3), provide details about the item you are
  selling and then click <strong>Save</strong> or <strong>Publish</strong>.</li>
</ol>

<img src="{@docRoot}images/billing_list_form.png" height="840" id="figure3" />
<p class="img-caption">
  <strong>Figure 3.</strong> The Create New In-app Product page lets you add items to an
  application's product list.
</p>

<p>You must enter the following information for each item in a product list:</p>
<ul>
  <li><strong>In-app Product ID</strong>
    <p>Product IDs are unique across an application's namespace. A product ID must start with a
    lowercase letter or a number, and must be composed using only lowercase letters (a-z), numbers
    (0-9), underlines (_), and dots (.). The product ID "android.test" is reserved, as are all
    product IDs that start with "android.test."</p>
    <p>In addition, you cannot modify an item's product ID after it is created, and you cannot reuse
    a product ID.</p>
  </li>
  <li><strong>Purchase Type</strong>
    <p>The purchase type can be <strong>Managed per user account</strong> or <strong>
    Unmanaged</strong>. You can never change an item's purchase type after you set it. For more
    information, see <a href="#billing-purchase-type">Choosing a purchase type</a> later in this
    document.</p>
  </li>
  <li><strong>Publishing State</strong>
    <p>An item's publishing state can be <strong>Published</strong> or <strong>Unpublished
    </strong>. To be visible to a user during checkout, an item's publishing state must be set to
    <strong>Published</strong> and the item's application must be published on Android Market.</p>
    <p class="note"><strong>Note:</strong> This is not true for test accounts. An item is visible to
    a test account if the application is not published and the item is published. See <a
    href="{@docRoot}guide/market/billing/billing_testing.html#billing-testing-real">Testing In-app
    Billing</a> for more information.</p>
  </li>
  <li><strong>Language</strong>
    <p>The language setting determines which languages are used to display the item title and
    item description during checkout. A product list inherits its default language from the
    parent application. You can add more languages by clicking <strong>add language</strong>. You
    can also choose to have the title and description automatically translated from the default
    language by selecting the <strong>Fill fields with auto translation</strong> checkbox (see
    figure 4). If you do not use the auto translation feature, you must provide the translated
    versions of the title and description.</p>
  </li>
  <li><strong>Title</strong>
    <p>The title is a short descriptor for the item. For example, "Sleeping potion." Titles must be
    unique across an application's namespace. Every item must have a title. The title is visible to
    users during checkout. For optimum appearance, titles should be no longer than 25 characters;
    however, titles can be up to 55 characters in length.</p>
  </li>
  <li><strong>Description</strong>
    <p>The description is a long descriptor for the item. For example, "Instantly puts creatures to
    sleep. Does not work on angry elves." Every item must have a description. The description is
    visible to users during checkout. Descriptions can be up to 80 characters in length.</p>
  </li>
  <li><strong>Price</strong>
    <p>You must provide a default price in your home currency. You can also provide prices in other
    currencies, but you can do this only if a currency's corresponding country is listed as a
    target country for your application. You can specify target countries on the Edit Application
    page in the Android Market developer console.</p>
    <p>To specify prices in other currencies, you can manually enter the price for each
    currency or you can click <strong>Auto Fill</strong> and let Android Market do a one-time
    conversion from your home currency to the currencies you are targeting (see figure 4).</p>
  </li>
</ul>
<img src="{@docRoot}images/billing_list_form_2.png" height="1226" id="figure4" />
<p class="img-caption">
  <strong>Figure 4.</strong> Specifying additional currencies and additional languages for the
  item title and description.
</p>

<p>For more information about product IDs and product lists, see <a
href="http://market.android.com/support/bin/answer.py?answer=1072599">Creating In-App Product
IDs</a>. For more information about pricing, see <a
href="http://market.android.com/support/bin/answer.py?answer=1153485">In-App Billing
Pricing</a>.</p>

<p class="note"><strong>Note</strong>: Be sure to plan your product ID namespace. You cannot reuse
or modify product IDs after you save them.</p>

<h3 id="billing-bulk-add">Adding a batch of items to a product list</h3>

<p>To add a batch of items to a product list using a CSV file, you first need to create your CSV
file. The data values that you specify in the CSV file represent the same data values you specify
manually through the In-app Products UI (see <a href="#billing-form-add">Adding items one at a time
to a product list</a>). The CSV file uses commas (,) and semi-colons (;) to separate data values.
Commas are used to separate primary data values, and semi-colons are used to separate subvalues. For
example, the syntax for the CSV file is as follows:</p>

<p>"<em>product_id</em>","<em>publish_state</em>","<em>purchase_type</em>","<em>autotranslate</em>
","<em>locale</em>; <em>title</em>; <em>description</em>","<em>autofill</em>","<em>country</em>;
<em>price</em>"
</p>

<p>Descriptions and usage details are provided below.</p>

<ul>
  <li><em>product_id</em>
    <p>This is equivalent to the In-app Product ID setting in the In-app Products UI. If you specify
    a <em>product_id</em> that already exists in a product list, and you choose to overwrite
    the product list while importing the CSV file, the data for the existing item is overwritten with
    the values specified in the CSV file. The overwrite feature does not delete items that are on a
    product list but not present in the CSV file.</p>
  </li>
  <li><em>publish_state</em>
    <p>This is equivalent to the Publishing State setting in the In-app Products UI. Can be <code>
    published</code> or <code>unpublished</code>.</p>
  </li>
  <li><em>purchase_type</em>
    <p>This is equivalent to the Purchase Type setting in the In-app Products UI. Can be <code>
    managed_by_android</code>, which is equivalent to <strong>Managed per user account
    </strong> in the In-app Products UI, or <code>managed_by_publisher</code>, which is equivalent
    to <strong>Unmanaged</strong> in the In-app Products UI.</p>
  </li>
  <li><em>autotranslate</em>
    <p>This is equivalent to selecting the <strong>Fill fields with auto translation</strong>
    checkbox in the In-app Products UI. Can be <code>true</code> or <code>false</code>.</p>
  </li>
  <li><em>locale</em>
    <p>This is equivalent to the Language setting in the In-app Products UI. You must have an entry
    for the default locale. The default locale must be the first entry in the list of
    locales, and it must include a <em>title</em> and <em>description</em>. If you want to provide
    translated versions of the <em>title</em> and <em>description</em> in addition to the default,
    you must use the following syntax rules:</p>
    <p>If <em>autotranslate</em> is <code>true</code>, you must specify the default locale,
    default title, default description, and other locales using the following format:</p>
    <p>"true,"<em>default_locale</em>; <em>default_locale_title</em>;
    <em>default_locale_description</em>; <em>locale_2</em>;    <em>locale_3</em>, ..."</p>
    <p>If <em>autotranslate</em> is <code>false</code>, you must specify the default locale,
    default title, and default description as well as the translated titles and descriptions using
    the following format:</p>
    <p>"false,"<em>default_locale</em>; <em>default_locale_title</em>;
    <em>default_locale_description</em>; <em>locale_2</em>; <em>locale_2_title</em>;
    <em>local_2_description</em>; <em>locale_3</em>; <em>locale_3_title</em>;
     <em>locale_3_description</em>; ..."</p>
    <p>See table 1 for a list of the language codes you can use with the <em>locale</em> field.</p>
  </li>
  <li><em>title</em>
    <p>This is equivalent to the Title setting in the In-app Products UI. If the <em>title</em>
    contains a semicolon, it must be escaped with a backslash (for example, "\;"). A backslash
    should also be escaped with a backslash (for example, "\\">.</p>
  </li>
  <li><em>description</em>
    <p>This is equivalent to the Description in the In-app Products UI. If the <em>description</em>
    contains a semicolon, it must be escaped with a backslash (for example, "\;"). A backslash
    should also be escaped with a backslash (for example, "\\">.</p>
  </li>
  <li><em>autofill</em>
    <p>This is equivalent to clicking <strong>Auto Fill</strong> in the In-app Products UI. Can be
    <code>true</code> or <code>false</code>. The syntax for specifying the <em>country</em>
    and <em>price</em> varies depending on which <em>autofill</em> setting you use.</p>
    <p>If <em>autofill</em> is set to <code>true</code>, you need to specify only the default
    price in your home currency and you must use this syntax:</p>
    <p>"true","<em>default_price_in_home_currency</em>"
    <p>If <em>autofill</em> is set to <code>false</code>, you need to specify a <em>country</em>
    and a <em>price</em> for each currency and you must use the following syntax:</p>
    <p>"false", "<em>home_country</em>; <em>default_price_in_home_currency</em>; <em>country_2</em>;
    <em>country_2_price</em>; <em>country_3</em>; <em>country_3_price</em>; ..."</p>
  </li>
  <li><em>country</em>
    <p>The country for which you are specifying a price. You can only list countries that your
    application is targeting. The country codes are two-letter uppercase
    ISO country codes (such as "US") as defined by
    <a href="http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-2</a>.</p>
  </li>
  <li><em>price</em>
    <p>This is equivalent to the Price in the In-app Products UI. The price must be specified in
    micro-units. To convert a currency value to micro-units, you multiply the real value by 1,000,000.
    For example, if you want to sell an in-app item for $1.99 you specify 1990000 in the
    <em>price</em> field.</p>
  </li>
</ul>

<p class="table-caption" id="language-table"><strong>Table 1.</strong> Language codes you can use
with the <em>locale</em> field.</p>

<table>

<tr>
<th>Language</th>
<th>Code</th>
<th>Language</th>
<th>Code</th>
</tr>
<tr>
<td>Chinese</td>
<td>zh_TW</td>
<td>Italian</td>
<td>it_IT</td>
</tr>
<tr>
<td>Czech</td>
<td>cs_CZ</td>
<td>Japanese</td>
<td>ja_JP</td>
</tr>
<tr>
<td>Danish</td>
<td>da_DK</td>
<td>Korean</td>
<td>ko_KR</td>
</tr>
<tr>
<td>Dutch</td>
<td>nl_NL</td>
<td>Norwegian</td>
<td>no_NO</td>
</tr>
<tr>
<td>English</td>
<td>en_US</td>
<td>Polish</td>
<td>pl_PL</td>
</tr>
<tr>
<td>French</td>
<td>fr_FR</td>
<td>Portuguese</td>
<td>pt_PT</td>
</tr>
<tr>
<td>Finnish</td>
<td>fi_FI</td>
<td>Russian</td>
<td>ru_RU</td>
</tr>
<tr>
<td>German</td>
<td>de_DE</td>
<td>Spanish</td>
<td>es_ES</td>
</tr>
<tr>
<td>Hebrew</td>
<td>iw_IL</td>
<td>Swedish</td>
<td>sv_SE</td>
</tr>
<tr>
<td>Hindi</td>
<td>hi_IN</td>
<td>--</td>
<td>--</td>
</tr>
</table>

<p>To import the items that are specified in your CSV file, do the following:</p>

<ol>
  <li><a href="http://market.android.com/publish">Log in</a> to your publisher account.</li>
  <li>In the <strong>All Android Market listings</strong> panel, under the application name, click
  <strong>In-app Products</strong>.</li>
  <li>On the In-app Products List page, click <strong>Choose File</strong> and select your CSV
file.
    <p>The CSV file must be on your local computer or on a local disk that is connected to your
    computer.</p>
  </li>
  <li>Select the <strong>Overwrite</strong> checkbox if you want to overwrite existing items in
  your product list.
    <p>This option overwrites values of existing items only if the value of the <em>product_id</em>
    in the CSV file matches the In-app Product ID for an existing item in the product list.
    Overwriting does not delete items that are on a product list but not present in the CSV
    file.</p>
  </li>
  <li>On the In-app Products List page, click <strong>Import from CSV</strong>.</li>
</ol>

<p>You can also export an existing product list to a CSV file by clicking <strong>Export to CSV
</strong> on the In-app Product List page. This is useful if you have manually added items to
a product list and you want to start managing the product list through a CSV file.</p>

<h3 id="billing-purchase-type">Choosing a Purchase Type</h3>

<p>An item's purchase type controls how Android Market manages the purchase of the item. There are
two purchase types: "managed per user account" and "unmanaged."</p>

<p>Items that are managed per user account can be purchased only once per user account. When an item
is managed per user account, Android Market permanently stores the transaction information for each
item on a per-user basis. This enables you to query Android Market with the
<code>RESTORE_TRANSACTIONS</code> request and restore the state of the items a specific user has
purchased.</p>

<p>If a user attempts to purchase a managed item that has already been purchased, Android Market
displays an "Item already purchased" error. This occurs during checkout, when Android Market
displays the price and description information on the checkout page. When the user dismisses the
error message, the checkout page disappears and the user returns to your user interface. As a best
practice, your application should prevent the user from seeing this error. The sample application
demonstrates how you can do this by keeping track of items that are managed and already purchased
and not allowing users to select those items from the list. Your application should do something
similar&mdash;either graying out the item or hiding it so that it cannot be selected.</p>

<p>The "manage by user account" purchase type is useful if you are selling items such as game levels
or application features. These items are not transient and usually need to be restored whenever a
user reinstalls your application, wipes the data on their device, or installs your application on a
new device.</p>

<p>Items that are unmanaged do not have their transaction information stored on Android Market,
which means you cannot query Android Market to retrieve transaction information for items whose
purchase type is listed as unmanaged. You are responsible for managing the transaction information
of unmanaged items. Also, unmanaged items can be purchased multiple times as far as Android Market
is concerned, so it's also up to you to control how many times an unmanaged item can be
purchased.</p>

<p>The "unmanaged" purchase type is useful if you are selling consumable items, such as fuel or
magic spells. These items are consumed within your application and are usually purchased multiple
times.</p>

<h2 id="billing-refunds">Handling Refunds</h2>

<p>In-app billing does not allow users to send a refund request to Android Market. Refunds for
in-app purchases must be directed to you (the application developer). You can then process the
refund through your Google Checkout merchant account. When you do this, Android Market receives a
refund notification from Google Checkout, and Android Market sends a refund message to your
application. For more information, see <a
href="{@docRoot}guide/market/billing/billing_overview.html#billing-action-notify">Handling
IN_APP_NOTIFY messages</a> and <a
href="http://www.google.com/support/androidmarket/bin/answer.py?answer=1153485">In-app Billing
Pricing</a>.</p>

<p class="caution"><strong>Important:</strong> You cannot use the Google Checkout API to issue
refunds or cancel in-app billing transactions. You must do this manually through your Google
Checkout merchant account. However, you can use the Google Checkout API to retrieve order
information.</p>

<h2 id="billing-testing-setup">Setting Up Test Accounts</h2>

<p>The Android Market publisher site lets you set up one or more test accounts. A test account is a
regular Google account that you register on the publisher site as a test account. Test accounts are
authorized to make in-app purchases from applications that you have uploaded to the Android Market
site but have not yet published.</p>

<p>You can use any Google account as a test account. Test accounts are useful if you want to let
multiple people test in-app billing on applications without giving them access to your publisher
account's sign-in credentials. If you want to own and control the test accounts, you can create the
accounts yourself and distribute the credentials to your developers or testers.</p>

<p>Test accounts have three limitations:</p>

<ul>
  <li>Test account users can make purchase requests only within applications that are already
  uploaded to your publisher account (although the application doesn't need to be published).</li>
  <li>Test accounts can only be used to purchase items that are listed (and published) in an
  application's product list.</li>
  <li>Test account users do not have access to your publisher account and cannot upload applications
  to your publisher account.</li>
</ul>

<p>To add test accounts to your publisher account, follow these steps:</p>

<ol>
  <li><a href="http://market.android.com/publish">Log in</a> to your publisher account.</li>
  <li>On the upper left part of the page, under your name, click <strong>Edit profile</strong>.</li>
  <li>On the Edit Profile page, scroll down to the Licensing &amp; In-app Billing panel (see figure
  5).</li>
  <li>In Test Accounts, add the email addresses for the test accounts you want to register,
  separating each account with a comma.</li>
  <li>Click <strong>Save</strong> to save your profile changes.</li>
</ol>

<img src="{@docRoot}images/billing_public_key.png" height="510" id="figure5" />
<p class="img-caption">
  <strong>Figure 5.</strong> The Licensing and In-app Billing panel of your account's Edit Profile
  page lets you register test accounts.
</p>

<h2 id="billing-support">Where to Get Support</h2>

<p>If you have questions or encounter problems while implementing in-app billing, contact the
support resources listed in the following table (see table 2). By directing your queries to the
correct forum, you can get the support you need more quickly.</p>

<p class="table-caption" id="support-table"><strong>Table 2.</strong> Developer support resources
for Android Market in-app billing.</p>

<table>

<tr>
<th>Support Type</th>
<th>Resource</th>
<th>Range of Topics</th>
</tr>
<tr>
<td rowspan="2">Development and testing issues</td>
<td>Google Groups: <a
href="http://groups.google.com/group/android-developers">android-developers</a> </td>
<td rowspan="2">In-app billing integration questions, user experience ideas, handling of responses,
obfuscating code, IPC, test environment setup.</td>
</tr>
<tr>
<td>Stack Overflow: <a
href="http://stackoverflow.com/questions/tagged/android">http://stackoverflow.com/questions/tagged/
android</a></td>
</tr>
<tr>
<td>Market billing issue tracker</td>
<td><a href="http://code.google.com/p/marketbilling/issues/">Market billing
project issue tracker</a></td>
<td>Bug and issue reports related specifically to in-app billing sample code.</td>
</tr>
</table>

<p>For general information about how to post to the groups listed above, see <a
href="{@docRoot}resources/community-groups.html">Developer Forums</a> document in the Resources
tab.</p>



