Skip to main content

MarketplaceUtils

Provides utility methods for MarketplaceService

Types​

CreatorProductInfo​

</>
interface CreatorProductInfo {
CreatorType: string--

Either User or Group

CreatorTargetId: number--

The ID of the creator user or group

Name: string--

The name/username of the creator

Id: number--

(Use CreatorTargetId instead)

}

Product info about the creator. See MarketplaceService.GetProductInfo.

AssetProductInfo​

</>
interface AssetProductInfo {
Creator: CreatorProductInfo--

A table of information describing the creator of the asset

AssetId: number--

If InfoType was Asset, this is the ID of the given asset.

AssetTypeId: number--

The type of asset (e.g. place, model, shirt)*

IsForSale: boolean--

Describes whether the asset is purchasable

IsLimited: boolean--

Describes whether the asset is a "limited item" that is no longer (if ever) sold

IsLimitedUnique: boolean--

Describes whether the asset is a "limited unique" ("Limited U") item

IsNew: boolean--

Describes whether the asset is marked as "new" in the catalog

Remaining: number--

The remaining number of items a limited unique item may be sold

Sales: number--

The number of items the asset has been sold

Name: string--

The name shown on the asset's page

Description: string--

The description as shown on the asset's page; can be nil if blank

PriceInRobux: number--

The cost of purchasing the asset using Robux

Created: string--

Timestamp of when the asset was created, e.g. 2018-08-01T17:55:11.98Z

Updated: string--

Timestamp of when the asset was last updated by its creator, e.g. 2018-08-01T17:55:11.98Z

ContentRatingTypeId: number--

Indicates whether the item is marked as 13+ in catalog

MinimumMembershipLevel: number--

The minimum subscription level necessary to purchase the item

IsPublicDomain: boolean--

Describes whether the asset can be taken for free

}

Product info result for assets.

GamePassOrDeveloperProductInfo​

</>
interface GamePassOrDeveloperProductInfo {
Creator: CreatorProductInfo--

A table of information describing the creator of the asset

ProductId: number--

If the InfoType was Product, this is the product ID

IconImageAssetId: number--

This is the asset ID of the product/pass icon, or 0 if there isn't one

Name: string--

The name shown on the asset's page

Description: string--

The description as shown on the asset's page; can be nil if blank

PriceInRobux: number--

The cost of purchasing the asset using Robux

Created: string--

Timestamp of when the asset was created, e.g. 2018-08-01T17:55:11.98Z

Updated: string--

Timestamp of when the asset was last updated by its creator, e.g. 2018-08-01T17:55:11.98Z

ContentRatingTypeId: number--

Indicates whether the item is marked as 13+ in catalog

MinimumMembershipLevel: number--

The minimum subscription level necessary to purchase the item

IsPublicDomain: boolean--

Describes whether the asset can be taken for free

}

Product info result for gamepasses.

UserSubscriptonStatus​

</>
interface UserSubscriptonStatus {
IsSubscribed: boolean--

True if the user's subscription is active.

IsRenewing: boolean--

True if the user is set to renew this subscription after the current subscription period ends.

}

Subscription Status

Functions​

promiseProductInfo​

</>
MarketplaceUtils.promiseProductInfo(
assetId: number,
infoType: InfoType | nil
) → Promise<AssetProductInfo | GamePassOrDeveloperProductInfo>

Wraps MarketplaceService.GetProductInfo and retrieves information about

promiseUserSubscriptionStatus​

</>
MarketplaceUtils.promiseUserSubscriptionStatus(
player: Player,
subscriptionId: string
) → UserSubscriptonStatus

Returns the subscription status

promiseUserOwnsGamePass​

</>
MarketplaceUtils.promiseUserOwnsGamePass(
userId: number,
gamePassId: number
) → Promise<boolean>

Retrieves whether a player owns a gamepass.

promisePlayerOwnsAsset​

</>
MarketplaceUtils.promisePlayerOwnsAsset(
player: Player,
assetId: number
) → Promise<boolean>

Retrieves whether a player owns an asset, such as a hat or some other item.

promisePlayerOwnsBundle​

</>
MarketplaceUtils.promisePlayerOwnsBundle(
player: Player,
bundleId: number
) → Promise<boolean>

Retrieves whether a player owns a bundle

Show raw api
{
    "functions": [
        {
            "name": "promiseProductInfo",
            "desc": "Wraps [MarketplaceService.GetProductInfo] and retrieves information about",
            "params": [
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "infoType",
                    "desc": "",
                    "lua_type": "InfoType | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<AssetProductInfo | GamePassOrDeveloperProductInfo>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        },
        {
            "name": "promiseUserSubscriptionStatus",
            "desc": "Returns the subscription status",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "subscriptionId",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "UserSubscriptonStatus"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 106,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        },
        {
            "name": "promiseUserOwnsGamePass",
            "desc": "Retrieves whether a player owns a gamepass.",
            "params": [
                {
                    "name": "userId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "gamePassId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 131,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        },
        {
            "name": "promisePlayerOwnsAsset",
            "desc": "Retrieves whether a player owns an asset, such as a hat or some other item.",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 156,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        },
        {
            "name": "promisePlayerOwnsBundle",
            "desc": "Retrieves whether a player owns a bundle",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "bundleId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 181,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "CreatorProductInfo",
            "desc": "Product info about the creator. See [MarketplaceService.GetProductInfo].",
            "fields": [
                {
                    "name": "CreatorType",
                    "lua_type": "string",
                    "desc": "Either User or Group"
                },
                {
                    "name": "CreatorTargetId",
                    "lua_type": "number",
                    "desc": "The ID of the creator user or group"
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": "The name/username of the creator"
                },
                {
                    "name": "Id",
                    "lua_type": "number",
                    "desc": "(Use CreatorTargetId instead)"
                }
            ],
            "source": {
                "line": 23,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        },
        {
            "name": "AssetProductInfo",
            "desc": "Product info result for assets.",
            "fields": [
                {
                    "name": "Creator",
                    "lua_type": "CreatorProductInfo",
                    "desc": "A table of information describing the creator of the asset"
                },
                {
                    "name": "AssetId",
                    "lua_type": "number",
                    "desc": "If InfoType was Asset, this is the ID of the given asset."
                },
                {
                    "name": "AssetTypeId",
                    "lua_type": "number",
                    "desc": "The type of asset (e.g. place, model, shirt)*"
                },
                {
                    "name": "IsForSale",
                    "lua_type": "boolean",
                    "desc": "Describes whether the asset is purchasable"
                },
                {
                    "name": "IsLimited",
                    "lua_type": "boolean",
                    "desc": "Describes whether the asset is a \"limited item\" that is no longer (if ever) sold"
                },
                {
                    "name": "IsLimitedUnique",
                    "lua_type": "boolean",
                    "desc": "Describes whether the asset is a \"limited unique\" (\"Limited U\") item"
                },
                {
                    "name": "IsNew",
                    "lua_type": "boolean",
                    "desc": "Describes whether the asset is marked as \"new\" in the catalog"
                },
                {
                    "name": "Remaining",
                    "lua_type": "number",
                    "desc": "The remaining number of items a limited unique item may be sold"
                },
                {
                    "name": "Sales",
                    "lua_type": "number",
                    "desc": "The number of items the asset has been sold"
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": "The name shown on the asset's page"
                },
                {
                    "name": "Description",
                    "lua_type": "string",
                    "desc": "The description as shown on the asset's page; can be nil if blank"
                },
                {
                    "name": "PriceInRobux",
                    "lua_type": "number",
                    "desc": "The cost of purchasing the asset using Robux"
                },
                {
                    "name": "Created",
                    "lua_type": "string",
                    "desc": "Timestamp of when the asset was created, e.g. 2018-08-01T17:55:11.98Z"
                },
                {
                    "name": "Updated",
                    "lua_type": "string",
                    "desc": "Timestamp of when the asset was last updated by its creator, e.g. 2018-08-01T17:55:11.98Z"
                },
                {
                    "name": "ContentRatingTypeId",
                    "lua_type": "number",
                    "desc": "Indicates whether the item is marked as 13+ in catalog"
                },
                {
                    "name": "MinimumMembershipLevel",
                    "lua_type": "number",
                    "desc": "The minimum subscription level necessary to purchase the item"
                },
                {
                    "name": "IsPublicDomain",
                    "lua_type": "boolean",
                    "desc": "Describes whether the asset can be taken for free"
                }
            ],
            "source": {
                "line": 46,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        },
        {
            "name": "GamePassOrDeveloperProductInfo",
            "desc": "Product info result for gamepasses.",
            "fields": [
                {
                    "name": "Creator",
                    "lua_type": "CreatorProductInfo",
                    "desc": "A table of information describing the creator of the asset"
                },
                {
                    "name": "ProductId",
                    "lua_type": "number",
                    "desc": "If the InfoType was Product, this is the product ID"
                },
                {
                    "name": "IconImageAssetId",
                    "lua_type": "number",
                    "desc": "This is the asset ID of the product/pass icon, or 0 if there isn't one"
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": "The name shown on the asset's page"
                },
                {
                    "name": "Description",
                    "lua_type": "string",
                    "desc": "The description as shown on the asset's page; can be nil if blank"
                },
                {
                    "name": "PriceInRobux",
                    "lua_type": "number",
                    "desc": "The cost of purchasing the asset using Robux"
                },
                {
                    "name": "Created",
                    "lua_type": "string",
                    "desc": "Timestamp of when the asset was created, e.g. 2018-08-01T17:55:11.98Z"
                },
                {
                    "name": "Updated",
                    "lua_type": "string",
                    "desc": "Timestamp of when the asset was last updated by its creator, e.g. 2018-08-01T17:55:11.98Z"
                },
                {
                    "name": "ContentRatingTypeId",
                    "lua_type": "number",
                    "desc": "Indicates whether the item is marked as 13+ in catalog"
                },
                {
                    "name": "MinimumMembershipLevel",
                    "lua_type": "number",
                    "desc": "The minimum subscription level necessary to purchase the item"
                },
                {
                    "name": "IsPublicDomain",
                    "lua_type": "boolean",
                    "desc": "Describes whether the asset can be taken for free"
                }
            ],
            "source": {
                "line": 63,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        },
        {
            "name": "UserSubscriptonStatus",
            "desc": "Subscription Status",
            "fields": [
                {
                    "name": "IsSubscribed",
                    "lua_type": "boolean",
                    "desc": "True if the user's subscription is active."
                },
                {
                    "name": "IsRenewing",
                    "lua_type": "boolean",
                    "desc": "True if the user is set to renew this subscription after the current subscription period ends."
                }
            ],
            "source": {
                "line": 72,
                "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
            }
        }
    ],
    "name": "MarketplaceUtils",
    "desc": "Provides utility methods for MarketplaceService",
    "source": {
        "line": 5,
        "path": "src/marketplaceutils/src/Shared/MarketplaceUtils.lua"
    }
}