Inappproducts

Note: This resource does not use the transactional "edits" functionality. Calls to this resource's methods take effect immediately, whether or not there is an open edit.

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "packageName": string,
  "sku": string,
  "status": string,
  "purchaseType": string,
  "defaultPrice": {
    "priceMicros": string,
    "currency": string
  },
  "prices": {
    (key): {
      "priceMicros": string,
      "currency": string
    }
  },
  "listings": {
    (key): {
      "title": string,
      "description": string
    }
  },
  "defaultLanguage": string,
  "subscriptionPeriod": string,
  "season": {
    "start": {
      "month": unsigned integer,
      "day": unsigned integer
    },
    "end": {
      "month": unsigned integer,
      "day": unsigned integer
    },
    "prorations": [
      {
        "start": {
          "month": unsigned integer,
          "day": unsigned integer
        },
        "defaultPrice": {
          "priceMicros": string,
          "currency": string
        }
      }
    ]
  },
  "trialPeriod": string
}

Property name	Value	Description	Notes
defaultLanguage	string	The default language of the localized data, specified with a BCP 47 language code. (For example, "en-US" for English as used in the U.S., "en-GB" for English as used in Great Britain, and so on.)
defaultPrice	nested object	Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency.
defaultPrice.currency	string	3 letter Currency code, as defined by ISO 4217.
defaultPrice.priceMicros	string	The price in millionths of the currency base unit represented as a string.
listings	object	List of localized title and description data.
listings.(key)	nested object	The language of the localized data, specified with a BCP 47 language code. (For example, "en-US" for English as used in the U.S., "en-GB" for English as used in Great Britain, and so on.)
listings.(key).description	string
listings.(key).title	string
packageName	string	The package name of the parent app.
prices	object	Prices per buyer region. None of these prices should be zero. In-app products can never be free. Prices are tax-inclusive. For information about how taxes are managed for your apps, see Tax rates & value-added tax (VAT).
prices.(key)	nested object	Key for the prices entry. This is a region code, specified in ISO 3166-2 format.
prices.(key).currency	string	3 letter Currency code, as defined by ISO 4217.
prices.(key).priceMicros	string	The price in millionths of the currency base unit represented as a string.
purchaseType	string	Purchase type enum value. Unmodifiable after creation. Acceptable values are: "managedUser" "subscription"
season	nested object	Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions.
season.end	nested object	Date on which the season ends. A seasonal subscription includes all days up to and including the end date; the season ends at 24:00 UTC on the end date. For example, if the season end date is 15 September, subscribers have access on 15 September but lose access at 0:00 UTC on 16 September.
season.end.day	unsigned integer	Date of the month on which the season ends. Must be an integer in the range 1-31. Valid range depends on the specified month; for example, if season.end.month is 4 (April), season.end.day must be 30 or lower.
season.end.month	unsigned integer	Month of the year in which the season ends, expressed as an integer. For example, 1 is January, 2 is February, and so on.
season.prorations[]	list	Optional list of prorated seasonal subscription prices. The prorated price is a discounted subscription price that becomes available after a specified date. Each prorated price specifies the date on which the discounted price takes effect, and the new pricing information. For example, if a normal seasonal subscription goes from 1 March to 1 September and costs €5, a content provider might set up a prorated price to drop the subscription cost to €2.50 starting on 1 July. (All prorated seasonal subscriptions end on the normal season end date.)
season.prorations[].defaultPrice	nested object	Default price for a prorated season subscription. Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on default_price.
season.prorations[].defaultPrice.currency	string	3 letter Currency code, as defined by ISO 4217.
season.prorations[].defaultPrice.priceMicros	string	Price of the prorated subscription, in millionths of the currency base unit represented as a string. For example, if the prorated subscription costs €2.5, priceMicros is "2500000".
season.prorations[].start	nested object	Defines the first day on which the prorated subscription price takes effect. The subscription price drops to the prorated price at 0:00 UTC on the specified start date.
season.prorations[].start.day	unsigned integer	Date of the month on which the prorated subscription price takes effect. Must be an integer in the range 1-31. Valid range depends on the specified month; for example, if season.prorates[n].month is 4 (April), season.prorates[n].day must be 30 or lower.
season.prorations[].start.month	unsigned integer	Month of the year in which the prorated subscription price takes effect, expressed as an integer. For example, 1 is January, 2 is February, and so on.
season.start	nested object	Date on which the season starts. Seasonal subscriptions begin at 0:00 UTC on the season start date.
season.start.day	unsigned integer	Date of the month on which the season starts. Must be an integer in the range 1-31. Valid range depends on the specified month; for example, if season.start.month is 4 (April), season.start.day must be 30 or lower.
season.start.month	unsigned integer	Month of the year in which the season starts, expressed as an integer. For example, 1 is January, 2 is February, and so on.
sku	string	The stock-keeping-unit (SKU) of the product, unique within an app.
status	string	Acceptable values are: "active" "inactive"
subscriptionPeriod	string	Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year).
trialPeriod	string	Trial period, specified in ISO 8601 format. Acceptable values are anything between "P7D" (seven days) and "P999D" (999 days). Seasonal subscriptions cannot have a trial period.

Methods

delete

Delete an in-app product for an app.

get

Returns information about the in-app product specified.

insert

Creates a new in-app product for an app.

list

List all the in-app products for an Android app, both subscriptions and managed in-app products..

patch

Updates the details of an in-app product. This method supports patch semantics.

update

Updates the details of an in-app product.