API reference
API reference
Select your platform
No SDKs available
No versions available

Product Interface

The class that represents the product information for a specific IAP which is available for purchase in your app. You can retrieve more information about the product(s) by using their SKU with Iap.getProductsBySku

Signature

interface Product

Properties

billingPlans : List?
[Get]
Billing plans related to the product.
Signature
abstract val billingPlans: List<BillingPlan>?
contentRating : ContentRating?
[Get]
The content rating of a Product that specifies the age rating as well as other important information that needs to be displayed to the user per local regulations.
Signature
abstract val contentRating: ContentRating?
coverUrl : String?
[Get]
The URI for the cover image for the Product being sold.
Signature
abstract val coverUrl: String?
description : String?
[Get]
The description for the product. The description should be meaningful and explanatory to help outline the product and its features.
Signature
abstract val description: String?
formattedPrice : String
[Get]
The formatted string for the Price. This is the same value stored in Price.
Signature
abstract val formattedPrice: String
iconUrl : String?
[Get]
The URI for Product icon.
Signature
abstract val iconUrl: String?
name : String
[Get]
The name of the product. This will be used as a the display name and should be aligned with the user facing title.
Signature
abstract val name: String
price : Price
[Get]
The Price of the product contains the currency code, the amount in hundredths, and the formatted string representation.
Signature
abstract val price: Price
shortDescription : String?
[Get]
The short description of a Product which provides more information about the Product. To be used in conjunction with the description of the Product.
Signature
abstract val shortDescription: String?
sku : String
[Get]
The unique string that you use to reference the product in your app. The SKU is case-sensitive and should match the SKU reference in your code.
Signature
abstract val sku: String
type : ProductType
[Get]
The type of product. An In-app purchase (IAP) add-on can be ProductType.Durable, ProductType.Consumable, or a ProductType.Subscription.
Signature
abstract val type: ProductType