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

Purchase Interface

A purchase is made when a user buys a Product. The IAP product, which can represent a consumable item, a durable item, or a subscription, must be defined for purchase through the developer dashboard.

Signature

interface Purchase

Properties

developerPayload : String?
[Get]
The developer payload feature is unimplemented.
Signature 
abstract val developerPayload: String?
expirationTime : LocalDateTime?
[Get]
The time when the purchased Product expires. This value only applies to subscriptions, and will be null for durable and consumable IAP items.
Signature 
abstract val expirationTime: LocalDateTime?
grantTime : LocalDateTime
[Get]
The timestamp that represents when the user was granted entitlement to the Product that was purchased.
Signature 
abstract val grantTime: LocalDateTime
purchaseId : String
[Get]
The unique identifier of a Purchase represents a user's unique entitlement to a Product. This value is 0 for shared IAP entitlements.
Signature 
abstract val purchaseId: String
reportingId : String?
[Get]
The Reporting ID feature is not implemented.
Signature 
abstract val reportingId: String?
sku : String
[Get]
The SKU of the IAP Product that was purchased. This value is case-sensitive. To retrieve the product information, you can use this value when calling Iap.getProductsBySku.
Signature 
abstract val sku: String
type : ProductType?
[Get]
The Type of the IAP Product that was purchased. The values can be ProductType.Durable, ProductType.Consumable, or a ProductType.Subscription.
Signature 
abstract val type: ProductType?
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta