• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    Payments

    The Payments service provides methods for creating and managing payments in your game. Check out the PaymentsError class for error codes that can be returned by the Payments service.

    Properties

    PurchaseHandler

    (purchase: WorldProductPurchase, player: Player) -> ()
    ServerOnly

    Methods

    Acknowledge a purchase made by the current user.

    Parameters

    wasConsumed
    boolean

    Returns

    void

    Acknowledge a purchase made by the current user.

    Parameters

    wasConsumed
    boolean
    callback
    (error: PaymentsError) -> ()

    Returns

    void

    Returns

    void

    GetProduct

    ServerOnly

    Get a product by its ID.

    Parameters

    productId
    string
    callback
    (product: WorldProduct, error: PaymentsError) -> ()

    Returns

    void

    GetProducts

    ServerOnly

    Get a list of In-World Purchases (IWP).

    Parameters

    cursorId
    string
    callback
    (products: {WorldProduct}, nextCursorId: string, error: PaymentsError) -> ()

    Returns

    void

    GetPurchases

    ServerOnly

    Get a list of purchases made by the specified user.

    Parameters

    player
    productId
    string
    limit
    number
    cursorId
    string
    callback
    (purchases: {WorldProductPurchase}, nextCursorId: string, error: PaymentsError) -> ()

    Returns

    void

    PromptPurchase

    ClientOnly

    Prompt the current user to make a purchase.

    Parameters

    productId
    string
    callback
    (obj: boolean) -> ()

    Returns

    void

    Updated 1 day ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.