plugin.apple.iap.* (Apple IAP)

Type Library
Revision Release 2024.3703
Keywords Apple, IAP, in-app purchases
Platforms iOS, macOS, tvOS

Overview

This library allows you to support in-app purchasing on iOS, tvOS and macOS, including in-game currency, upgrades, and more.

For in-app purchasing on other platforms, see the documentation for Google IAP or Amazon IAP.

Notes

  • To use in-app purchases on iOS, you must first configure your iOS certificates, App IDs, and provisioning profiles. Please review our Provisioning and Building guide thoroughly, as this is an essential task and you must complete each step correctly. Also remember to create an App ID that is unique and fully qualified, not a wildcard App ID.

  • Additional configuration must occur within iTunes Connect. If you need assistance with this process, please see Apple’s documentation.

Syntax

local store = require( "plugin.apple.iap" )

Properties

store.target

store.isActive

store.canLoadProducts

store.canMakePurchases

Functions

store.init()

store.loadProducts()

store.purchase()

store.finishTransaction()

store.restore()

store.receiptRawData()

store.receiptBase64Data()

store.receiptDecrypted()

store.receiptAvailable()

store.receiptRequest()

store.deferStorePurchases()

store.proceedToPayment()

store.presentCodeRedemptionSheet()

Events

storeTransaction

productList

appStorePurchase

Project Settings

To use this plugin, add an entry into the plugins table of build.settings. When added, the build server will integrate the plugin during the build phase.

settings =
{
    plugins =
    {
        ["plugin.apple.iap"] =
        {
            publisherId = "com.coronalabs"
        },
    },
}