REST Resource: inappproducts

Resource: InAppProduct

An in-app product. The resource for InappproductsService.

JSON representation
{
  "packageName": string,
  "sku": string,
  "status": enum (Status),
  "purchaseType": enum (PurchaseType),
  "defaultPrice": {
    object (Price)
  },
  "prices": {
    string: {
      object (Price)
    },
    ...
  },
  "listings": {
    string: {
      object (InAppProductListing)
    },
    ...
  },
  "defaultLanguage": string,
  "subscriptionPeriod": string,
  "trialPeriod": string,
  "gracePeriod": string,

  // Union field TaxAndComplianceType can be only one of the following:
  "subscriptionTaxesAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "managedProductTaxesAndComplianceSettings": {
    object (ManagedProductTaxAndComplianceSettings)
  }
  // End of list of possible types for union field TaxAndComplianceType.
}
Fields
packageName

string

Package name of the parent app.

sku

string

Stock-keeping-unit (SKU) of the product, unique within an app.

status

enum (Status)

The status of the product, e.g. whether it's active.

purchaseType

enum (PurchaseType)

The type of the product, e.g. a recurring subscription.

defaultPrice

object (Price)

Default price. Cannot be zero, as in-app products are never free. Always in the developer's Checkout merchant currency.

prices

map (key: string, value: object (Price))

Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

listings

map (key: string, value: object (InAppProductListing))

apks.list of localized title and description data. Map key is the language of the localized data, as defined by BCP-47, e.g. "en-US".

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

defaultLanguage

string

Default language of the localized data, as defined by BCP-47. e.g. "en-US".

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

gracePeriod

string

Grace period of the subscription, specified in ISO 8601 format. Allows developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values are P0D (zero days), P3D (three days), P7D (seven days), P14D (14 days), and P30D (30 days).

Union field TaxAndComplianceType.

TaxAndComplianceType can be only one of the following:

subscriptionTaxesAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Details about taxes and legal compliance. Only applicable to subscription products.

managedProductTaxesAndComplianceSettings

object (ManagedProductTaxAndComplianceSettings)

Details about taxes and legal compliance. Only applicable to managed products.

Status

The status of an in-app product.

Enums
statusUnspecified Unspecified status.
active The product is published and active in the store.
inactive The product is not published and therefore inactive in the store.

PurchaseType

The type of the product.

Enums
purchaseTypeUnspecified Unspecified purchase type.
managedUser The default product type - one time purchase.
subscription In-app product with a recurring period.

InAppProductListing

Store listing of a single in-app product.

JSON representation
{
  "title": string,
  "description": string,
  "benefits": [
    string
  ]
}
Fields
title

string

Title for the store listing.

description

string

Description for the store listing.

benefits[]

string

Localized entitlement benefits for a subscription.

SubscriptionTaxAndComplianceSettings

Details about taxation, Google Play policy and legal compliance for subscription products.

JSON representation
{
  "eeaWithdrawalRightType": enum (WithdrawalRightType),
  "taxRateInfoByRegionCode": {
    string: {
      object (RegionalTaxRateInfo)
    },
    ...
  }
}
Fields
eeaWithdrawalRightType

enum (WithdrawalRightType)

Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the Help Center article for more information.

taxRateInfoByRegionCode

map (key: string, value: object (RegionalTaxRateInfo))

A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

WithdrawalRightType

For products distributed in the EEA, represents whether the product is classified as a Digital Content or a Service.

Enums
WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED
WITHDRAWAL_RIGHT_DIGITAL_CONTENT
WITHDRAWAL_RIGHT_SERVICE

RegionalTaxRateInfo

Specified details about taxation in a given geographical region.

JSON representation
{
  "taxTier": enum (TaxTier),
  "eligibleForStreamingServiceTaxRate": boolean
}
Fields
taxTier

enum (TaxTier)

Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates.

Learn more.

eligibleForStreamingServiceTaxRate

boolean

You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in United States.

TaxTier

Each region may define a different number of tax tiers. The tax rate is computed as a function of a tuple T := {regionCode, taxTier}.

The tax rate associated with T may change over time. These tiers are in no particular order.

Log into Play Console for the current rates these tiers map to and see Help Center article for more information. Next id: 5

Enums
TAX_TIER_UNSPECIFIED
TAX_TIER_BOOKS_1
TAX_TIER_NEWS_1
TAX_TIER_NEWS_2

ManagedProductTaxAndComplianceSettings

Details about taxation and legal compliance for managed products.

JSON representation
{
  "eeaWithdrawalRightType": enum (WithdrawalRightType),
  "taxRateInfoByRegionCode": {
    string: {
      object (RegionalTaxRateInfo)
    },
    ...
  }
}
Fields
eeaWithdrawalRightType

enum (WithdrawalRightType)

Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the Help Center article for more information.

taxRateInfoByRegionCode

map (key: string, value: object (RegionalTaxRateInfo))

A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

delete

Deletes an in-app product (i.e.

get

Gets an in-app product, which can be a managed product or a subscription.

insert

Creates an in-app product (i.e.

list

Lists all in-app products - both managed products and subscriptions.

patch

Patches an in-app product (i.e.

update

Updates an in-app product (i.e.