- Resource: InAppProduct
- Status
- PurchaseType
- InAppProductListing
- ManagedProductTaxAndComplianceSettings
- Methods
Resource: InAppProduct
An in-app product. The resource for InappproductsService.
JSON representation |
---|
{ "packageName" : string , "sku" : string , "status" : enum ( |
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
))
inappproducts.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
|
Title for the store listing. |
description
|
Description for the store listing. |
benefits[]
|
Localized entitlement benefits for a subscription. |
ManagedProductTaxAndComplianceSettings
Details about taxation and legal compliance for managed products.
JSON representation |
---|
{ "eeaWithdrawalRightType" : enum ( |
Fields | |
---|---|
eeaWithdrawalRightType
|
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
|
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 |
isTokenizedDigitalAsset
|
Whether this in-app product is declared as a product representing a tokenized digital asset. |
Methods |
|
---|---|
|
Deletes in-app products (managed products or subscriptions). |
|
Reads multiple in-app products, which can be managed products or subscriptions. |
|
Updates or inserts one or more in-app products (managed products or subscriptions). |
|
Deletes an in-app product (a managed product or a subscription). |
|
Gets an in-app product, which can be a managed product or a subscription. |
|
Creates an in-app product (a managed product or a subscription). |
|
Lists all in-app products - both managed products and subscriptions. |
|
Patches an in-app product (a managed product or a subscription). |
|
Updates an in-app product (a managed product or a subscription). |