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

Purchase

Updated: Aug 26, 2025

Purchase

interface Purchase
A purchase is made when a user buys a horizon.platform.iap.models.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.

Properties

NameSummary
developerPayload
abstract val developerPayload: String?
The developer payload feature is unimplemented.
expirationTime
abstract val expirationTime: LocalDateTime?
The time when the purchased horizon.platform.iap.models.Product expires. This value only applies to subscriptions, and will be null for durable and consumable IAP items.
grantTime
abstract val grantTime: LocalDateTime
The timestamp that represents when the user was granted entitlement to the horizon.platform.iap.models.Product that was purchased.
json
open val json: String
purchaseId
abstract val purchaseId: String
The unique identifier of a horizon.platform.iap.models.Purchase represents a user’s unique entitlement to a horizon.platform.iap.models.Product. This value is 0 for shared IAP entitlements.
reportingId
abstract val reportingId: String?
The Reporting ID feature is not implemented.
sku
abstract val sku: String
The SKU of the IAP horizon.platform.iap.models.Product that was purchased. This value is case-sensitive. To retrieve the product information, you can use this value when calling horizon.platform.iap.Iap.getProductsBySku.
type
abstract val type: ProductType?
The Type of the IAP horizon.platform.iap.models.Product that was purchased. The values can be horizon.platform.iap.enums.ProductType.durable, horizon.platform.iap.enums.ProductType.consumable, or a horizon.platform.iap.enums.ProductType.subscription.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon