In-Game Purchases

Enable players to purchase items, upgrades, or currency within your game to enhance their experience and generate revenue.

There are two types of purchases: permanent (e.g., removing ads) and consumable (e.g., in-game coins).

Support

Check if in-game purchases are supported to offer items or upgrades within the game.

Bridge.payments.is_supported

Setup

Setup in-game purchases in the config file. For each product add a commonId and fill in the information for the required platforms, example for one product:

{
    ...    
    "payments": [
        {
            "commonId": "test_product",
            "yandex": {
                "id": "YANDEX_ID_HERE"
            },
            "facebook": {
                "productID": "FACEBOOK_ID_HERE"
            },
            "msn": {
                "productId": "MSN_ID_HERE"
            },
            "playgama": {
                "amount": 1 // price in Golden Fennec
            },
            "qa_tool": {
                "id": "QA_TOOL_ID_HERE",
                "amount": 1 // price in Golden Fennec
            },
            "playdeck": {
                "amount": 1, // price in Telegram Stars
                "description": "TEST PRODUCT"
            }
        }
    ]
}

Purchase

Allow players to buy items or upgrades in your game to enhance their gameplay experience.

Godot 3.x

func _ready():
    var commonId = "test_product" # commonId you specified in the config file
    Bridge.payments.purchase(commonId, funcref(self, "_on_purchase_completed"))

func _on_purchase_completed(success, purchase):
    print(success)

Godot 4.x

func _ready():
    var commonId = "test_product" # commonId you specified in the config file
    Bridge.payments.purchase(commonId, Callable(self, "_on_purchase_completed"))

func _on_purchase_completed(success, purchase):
    print(success)

Consumable

Consume purchased items, such as in-game currency, once they are used, to manage inventory and player progression.

Godot 3.x

func _ready():
    var commonId = "test_product" # commonId you specified in the config file
    Bridge.payments.consume_purchase(commonId, funcref(self, "_on_consume_completed"))

func _on_consume_completed(success):
    print(success)

Godot 4.x

func _ready():
    var commonId = "test_product" # commonId you specified in the config file
    Bridge.payments.consume_purchase(commonId, Callable(self, "_on_consume_completed"))

func _on_consume_completed(success):
    print(success)

Catalog of All Items

Retrieve a list of all available in-game items that players can purchase to display in the game store.

Godot 3.x

func _ready():
    Bridge.payments.get_catalog(funcref(self, "_on_get_catalog_completed"))

func _on_get_catalog_completed(success, catalog):
    print(success)
    
    for item in catalog:
        print("Common ID: " + str(item.commonId))
        print("Price: " + str(item.price))
        print("Price Currency Code: " + str(item.priceCurrencyCode))
        print("Price Value: " + str(item.priceValue))

Godot 4.x

func _ready():
    Bridge.payments.get_catalog(Caallable(self, "_on_get_catalog_completed"))

func _on_get_catalog_completed(success, catalog):
    print(success)
    
    for item in catalog:
        print("Common ID: " + str(item.commonId))
        print("Price: " + str(item.price))
        print("Price Currency Code: " + str(item.priceCurrencyCode))
        print("Price Value: " + str(item.priceValue))

List of Purchased Items

Retrieve a list of items that the player has purchased to manage their inventory and provide access to purchased content.

If the user loses internet connection when making an in-game purchase, the purchase might remain unprocessed. To avoid this, check for unprocessed purchases using this method (e.g., each time the game is launched).

Godot 3.x

func _ready():
    Bridge.payments.get_purchases(funcref(self, "_on_get_purchases_completed"))

func _on_get_purchases_completed(success, purchases):
    print(success)
    
    for purchase in purchases:
        print("Common Id: " + str(purchase.commonId))

Godot 4.x

func _ready():
    Bridge.payments.get_purchases(Callable(self, "_on_get_purchases_completed"))

func _on_get_purchases_completed(success, purchases):
    print(success)
    
    for purchase in purchases:
        print("Common Id: " + str(purchase.commonId))