Reference API Roblox

Engine API

Website

Related

Reference API Roblox

MarketplaceService

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 78

HistoryMember
462GetDeveloperProductsAsync(): Instance
462GetProductInfo(assetId: int64, infoType: InfoType = Asset): Dictionary
462GetRobuxBalance(): int
593GetSubscriptionProductInfoAsync(subscriptionId: string): Dictionary
589GetSubscriptionPurchaseInfoAsync(subscriptionId: string): Dictionary
614GetUserSubscriptionDetailsAsync(user: Player, subscriptionId: string): Dictionary
593GetUserSubscriptionPaymentHistoryAsync(user: Player, subscriptionId: string): Array
593GetUserSubscriptionStatusAsync(user: Player, subscriptionId: string): Dictionary
625PerformBulkPurchase(orderRequest: Dictionary, options: Dictionary): Dictionary
580PerformPurchase(infoType: InfoType, productId: int64, expectedPrice: int, requestId: string, isRobloxPurchase: bool, collectibleItemId: string = , collectibleProductId: string = , idempotencyKey: string = , purchaseAuthToken: string = ): Dictionary
587PerformPurchaseV2(infoType: InfoType, productId: int64, expectedPrice: int, requestId: string, isRobloxPurchase: bool, collectiblesProductDetails: Dictionary): Dictionary
597PerformSubscriptionPurchase(subscriptionId: string): string
618PerformSubscriptionPurchaseV2(subscriptionId: string, paymentProvider: string): null
462PlayerCanMakePurchases(player: Instance): bool
462PlayerOwnsAsset(player: Instance, assetId: int64): bool
529PlayerOwnsBundle(player: Player, bundleId: int64): bool
588PrepareCollectiblesPurchase(player: Instance, assetId: int64, collectibleItemId: string, collectibleItemInstanceId: string, collectibleProductId: string, expectedPrice: int): null
625PromptBulkPurchase(player: Player, lineItems: Array, options: Dictionary): null
573PromptBundlePurchase(player: Instance, bundleId: int64): null
588PromptCollectiblesPurchase(player: Instance, assetId: int64, collectibleItemId: string, collectibleItemInstanceId: string, collectibleProductId: string, expectedPrice: int): null
573PromptGamePassPurchase(player: Instance, gamePassId: int64): null
573PromptNativePurchase(player: Instance, productId: string): null
573PromptNativePurchaseWithLocalPlayer(productId: string): null
573PromptPremiumPurchase(player: Instance): null
573PromptProductPurchase(player: Instance, productId: int64, equipIfPurchased: bool = true, currencyType: CurrencyType = Default): null
573PromptPurchase(player: Instance, assetId: int64, equipIfPurchased: bool = true, currencyType: CurrencyType = Default): null
573PromptRobloxPurchase(assetId: int64, equipIfPurchased: bool): null
590PromptSubscriptionPurchase(user: Player, subscriptionId: string): null
573PromptThirdPartyPurchase(player: Instance, productId: string): null
573ReportAssetSale(assetId: string, robuxAmount: int): null
573ReportRobuxUpsellStarted(): null
573SignalAssetTypePurchased(player: Instance, assetType: AssetType): null
573SignalClientPurchaseSuccess(ticket: string, playerId: int64, productId: int64): null
573SignalMockPurchasePremium(): null
625SignalPromptBulkPurchaseFinished(status: MarketplaceBulkPurchasePromptStatus, results: Dictionary): null
573SignalPromptBundlePurchaseFinished(player: Instance, bundleId: int64, success: bool): null
573SignalPromptGamePassPurchaseFinished(player: Instance, gamePassId: int64, success: bool): null
573SignalPromptPremiumPurchaseFinished(didTryPurchasing: bool): null
573SignalPromptProductPurchaseFinished(userId: int64, productId: int64, success: bool): null
573SignalPromptPurchaseFinished(player: Instance, assetId: int64, success: bool): null
592SignalPromptSubscriptionPurchaseFinished(subscriptionId: string, didTryPurchasing: bool): null
573SignalServerLuaDialogClosed(value: bool): null
462UserOwnsGamePassAsync(userId: int64, gamePassId: int64): bool
462ClientLuaDialogRequested(arguments: Tuple)
462ClientPurchaseSuccess(ticket: string, playerId: int64, productId: int64)
462NativePurchaseFinished(player: Instance, productId: string, wasPurchased: bool)
546NativePurchaseFinishedWithLocalPlayer(productId: string, wasPurchased: bool)
588PrepareCollectiblesPurchaseRequested(player: Instance, assetId: int64, collectibleItemId: string, collectibleItemInstanceId: string, collectibleProductId: string, expectedPrice: int)
625PromptBulkPurchaseFinished(player: Instance, status: MarketplaceBulkPurchasePromptStatus, results: Dictionary)
625PromptBulkPurchaseRequested(player: Instance, displayData: Array, orderRequest: Dictionary, purchaserRobuxBalance: int64, orderTotalRobux: int64, options: Dictionary)
462PromptBundlePurchaseFinished(player: Instance, bundleId: int64, wasPurchased: bool)
462PromptBundlePurchaseRequested(player: Instance, bundleId: int64)
618PromptCollectibleBundlePurchaseRequested(player: Instance, bundleId: int64, collectibleItemId: string, collectibleItemInstanceId: string, collectibleProductId: string, expectedPrice: int, idempotencyKey: string, purchaseAuthToken: string)
588PromptCollectiblesPurchaseRequested(player: Instance, assetId: int64, collectibleItemId: string, collectibleItemInstanceId: string, collectibleProductId: string, expectedPrice: int, idempotencyKey: string, purchaseAuthToken: string)
462PromptGamePassPurchaseFinished(player: Instance, gamePassId: int64, wasPurchased: bool)
462PromptGamePassPurchaseRequested(player: Instance, gamePassId: int64)
462PromptPremiumPurchaseFinished()
462PromptPremiumPurchaseRequested(player: Instance)
557PromptProductPurchaseFinished(userId: int64, productId: int64, isPurchased: bool)
462PromptProductPurchaseRequested(player: Instance, productId: int64, equipIfPurchased: bool, currencyType: CurrencyType)
462PromptPurchaseFinished(player: Instance, assetId: int64, isPurchased: bool)
462PromptPurchaseRequested(player: Instance, assetId: int64, equipIfPurchased: bool, currencyType: CurrencyType)
580PromptPurchaseRequestedV2(player: Instance, assetId: int64, equipIfPurchased: bool, currencyType: CurrencyType, idempotencyKey: string, purchaseAuthToken: string)
462PromptRobloxPurchaseRequested(assetId: int64, equipIfPurchased: bool)
592PromptSubscriptionPurchaseFinished(user: Player, subscriptionId: string, didTryPurchasing: bool)
590PromptSubscriptionPurchaseRequested(subscriptionId: string)
462ServerPurchaseVerification(serverResponseTable: Dictionary)
462ThirdPartyPurchaseFinished(player: Instance, productId: string, receipt: string, wasPurchased: bool)
462ProcessReceipt(receiptInfo: Dictionary): ProductPurchaseDecision
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 10

HistoryMember
396GetSubscriptionStatus(player: Instance, subscriptionId: int64): Dictionary
589IsPlayerSubscribed(player: Instance, subscriptionId: int64): bool
589PromptSubscriptionCancellation(player: Instance, subscriptionId: int64): null
158SetDevProductInfoUrl(url: string): void
158SetPlayerOwnsAssetUrl(url: string): void
158SetProductInfoUrl(url: string): void
589SignalPromptSubscriptionCancellationFinished(player: Instance, subscriptionId: int64, wasCanceled: bool): null
589PromptSubscriptionCancellationFinished(player: Instance, subscriptionId: int64, wasCanceled: bool)
589PromptSubscriptionCancellationRequested(player: Instance, subscriptionId: int64)

History 235

Members 78

ClientLuaDialogRequested

Parameters (1)
argumentsTuple

History 2

ClientPurchaseSuccess

Parameters (3)
ticketstring
playerIdint64
productIdint64

History 3

GetDeveloperProductsAsync

Parameters (0)
No parameters.
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetProductInfo

Parameters (2)Default
assetIdint64
infoTypeInfoTypeAsset
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields]

GetRobuxBalance

Parameters (0)
No parameters.
Returns (1)
int
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetSubscriptionProductInfoAsync

Parameters (1)
subscriptionIdstring
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetSubscriptionPurchaseInfoAsync

Parameters (1)
subscriptionIdstring
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetUserSubscriptionDetailsAsync

Parameters (2)
userPlayer
subscriptionIdstring
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetUserSubscriptionPaymentHistoryAsync

Parameters (2)
userPlayer
subscriptionIdstring
Returns (1)
Array
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetUserSubscriptionStatusAsync

Parameters (2)
userPlayer
subscriptionIdstring
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

NativePurchaseFinished

Parameters (3)
playerInstance
productIdstring
wasPurchasedbool

History 2

NativePurchaseFinishedWithLocalPlayer

Parameters (2)
productIdstring
wasPurchasedbool

History 1

PerformBulkPurchase

Parameters (2)
orderRequestDictionary
optionsDictionary
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

PerformPurchase

Parameters (9)Default
infoTypeInfoType
productIdint64
expectedPriceint
requestIdstring
isRobloxPurchasebool
collectibleItemIdstring
collectibleProductIdstring
idempotencyKeystring
purchaseAuthTokenstring
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 6

Tags: [Yields]

PerformPurchaseV2

Parameters (6)
infoTypeInfoType
productIdint64
expectedPriceint
requestIdstring
isRobloxPurchasebool
collectiblesProductDetailsDictionary
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

PerformSubscriptionPurchase

Parameters (1)
subscriptionIdstring
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

PerformSubscriptionPurchaseV2

Parameters (2)
subscriptionIdstring
paymentProviderstring
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

PlayerCanMakePurchases

Parameters (1)
playerInstance
Returns (1)
bool

History 2

PlayerOwnsAsset

Parameters (2)
playerInstance
assetIdint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

PlayerOwnsBundle

Parameters (2)
playerPlayer
bundleIdint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

PrepareCollectiblesPurchase

Parameters (6)
playerInstance
assetIdint64
collectibleItemIdstring
collectibleItemInstanceIdstring
collectibleProductIdstring
expectedPriceint
Returns (1)
null

History 2

PrepareCollectiblesPurchaseRequested

Parameters (6)
playerInstance
assetIdint64
collectibleItemIdstring
collectibleItemInstanceIdstring
collectibleProductIdstring
expectedPriceint

History 2

ProcessReceipt

Parameters (1)
receiptInfoDictionary
Returns (1)
ProductPurchaseDecision

History 3

PromptBulkPurchase

Parameters (3)
playerPlayer
lineItemsArray
optionsDictionary
Returns (1)
null

History 1

PromptBulkPurchaseFinished

Parameters (3)
playerInstance
statusMarketplaceBulkPurchasePromptStatus
resultsDictionary

History 1

PromptBulkPurchaseRequested

Parameters (6)
playerInstance
displayDataArray
orderRequestDictionary
purchaserRobuxBalanceint64
orderTotalRobuxint64
optionsDictionary

History 1

PromptBundlePurchase

Parameters (2)
playerInstance
bundleIdint64
Returns (1)
null

History 4

PromptBundlePurchaseFinished

Parameters (3)
playerInstance
bundleIdint64
wasPurchasedbool

History 3

PromptBundlePurchaseRequested

Parameters (2)
playerInstance
bundleIdint64

History 2

PromptCollectibleBundlePurchaseRequested

Parameters (8)
playerInstance
bundleIdint64
collectibleItemIdstring
collectibleItemInstanceIdstring
collectibleProductIdstring
expectedPriceint
idempotencyKeystring
purchaseAuthTokenstring

History 1

PromptCollectiblesPurchase

Parameters (6)
playerInstance
assetIdint64
collectibleItemIdstring
collectibleItemInstanceIdstring
collectibleProductIdstring
expectedPriceint
Returns (1)
null

History 2

PromptCollectiblesPurchaseRequested

Parameters (8)
playerInstance
assetIdint64
collectibleItemIdstring
collectibleItemInstanceIdstring
collectibleProductIdstring
expectedPriceint
idempotencyKeystring
purchaseAuthTokenstring

History 2

PromptGamePassPurchase

Parameters (2)
playerInstance
gamePassIdint64
Returns (1)
null

History 6

PromptGamePassPurchaseFinished

Parameters (3)
playerInstance
gamePassIdint64
wasPurchasedbool

History 5

PromptGamePassPurchaseRequested

Parameters (2)
playerInstance
gamePassIdint64

History 5

PromptNativePurchase

Parameters (2)
playerInstance
productIdstring
Returns (1)
null

History 3

PromptNativePurchaseWithLocalPlayer

Parameters (1)
productIdstring
Returns (1)
null

History 2

PromptPremiumPurchase

Parameters (1)
playerInstance
Returns (1)
null

History 3

PromptPremiumPurchaseFinished

Parameters (0)
No parameters.

History 2

PromptPremiumPurchaseRequested

Parameters (1)
playerInstance

History 2

PromptProductPurchase

Parameters (4)Default
playerInstance
productIdint64
equipIfPurchasedbooltrue
currencyTypeCurrencyTypeDefault
Returns (1)
null

History 4

PromptProductPurchaseFinished

Parameters (3)
userIdint64
productIdint64
isPurchasedbool

History 5

PromptProductPurchaseRequested

Parameters (4)
playerInstance
productIdint64
equipIfPurchasedbool
currencyTypeCurrencyType

History 3

PromptPurchase

Parameters (4)Default
playerInstance
assetIdint64
equipIfPurchasedbooltrue
currencyTypeCurrencyTypeDefault
Returns (1)
null

History 4

PromptPurchaseFinished

Parameters (3)
playerInstance
assetIdint64
isPurchasedbool

History 3

PromptPurchaseRequested

Parameters (4)
playerInstance
assetIdint64
equipIfPurchasedbool
currencyTypeCurrencyType

History 3

PromptPurchaseRequestedV2

Parameters (6)
playerInstance
assetIdint64
equipIfPurchasedbool
currencyTypeCurrencyType
idempotencyKeystring
purchaseAuthTokenstring

History 1

PromptRobloxPurchase

Parameters (2)
assetIdint64
equipIfPurchasedbool
Returns (1)
null

History 3

PromptRobloxPurchaseRequested

Parameters (2)
assetIdint64
equipIfPurchasedbool

History 2

PromptSubscriptionPurchase

Parameters (2)
userPlayer
subscriptionIdstring
Returns (1)
null

History 6

PromptSubscriptionPurchaseFinished

Parameters (3)
userPlayer
subscriptionIdstring
didTryPurchasingbool

History 8

PromptSubscriptionPurchaseRequested

Parameters (1)
subscriptionIdstring

History 4

PromptThirdPartyPurchase

Parameters (2)
playerInstance
productIdstring
Returns (1)
null

History 4

ReportAssetSale

Parameters (2)
assetIdstring
robuxAmountint
Returns (1)
null

History 3

ReportRobuxUpsellStarted

Parameters (0)
No parameters.
Returns (1)
null

History 3

ServerPurchaseVerification

Parameters (1)
serverResponseTableDictionary

History 2

SignalAssetTypePurchased

Parameters (2)
playerInstance
assetTypeAssetType
Returns (1)
null

History 3

SignalClientPurchaseSuccess

Parameters (3)
ticketstring
playerIdint64
productIdint64
Returns (1)
null

History 4

SignalMockPurchasePremium

Parameters (0)
No parameters.
Returns (1)
null

History 3

SignalPromptBulkPurchaseFinished

Parameters (2)
statusMarketplaceBulkPurchasePromptStatus
resultsDictionary
Returns (1)
null

History 1

SignalPromptBundlePurchaseFinished

Parameters (3)
playerInstance
bundleIdint64
successbool
Returns (1)
null

History 3

SignalPromptGamePassPurchaseFinished

Parameters (3)
playerInstance
gamePassIdint64
successbool
Returns (1)
null

History 6

SignalPromptPremiumPurchaseFinished

Parameters (1)
didTryPurchasingbool
Returns (1)
null

History 3

SignalPromptProductPurchaseFinished

Parameters (3)
userIdint64
productIdint64
successbool
Returns (1)
null

History 4

SignalPromptPurchaseFinished

Parameters (3)
playerInstance
assetIdint64
successbool
Returns (1)
null

History 4

SignalPromptSubscriptionPurchaseFinished

Parameters (2)
subscriptionIdstring
didTryPurchasingbool
Returns (1)
null

History 6

SignalServerLuaDialogClosed

Parameters (1)
valuebool
Returns (1)
null

History 3

ThirdPartyPurchaseFinished

Parameters (4)
playerInstance
productIdstring
receiptstring
wasPurchasedbool

History 3

UserOwnsGamePassAsync

Parameters (2)
userIdint64
gamePassIdint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

Removed members 10

GetSubscriptionStatus

Parameters (2)
playerInstance
subscriptionIdint64
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

IsPlayerSubscribed

Parameters (2)
playerInstance
subscriptionIdint64
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields, Deprecated]

PromptSubscriptionCancellation

Parameters (2)
playerInstance
subscriptionIdint64
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

PromptSubscriptionCancellationFinished

Parameters (3)
playerInstance
subscriptionIdint64
wasCanceledbool
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

PromptSubscriptionCancellationRequested

Parameters (2)
playerInstance
subscriptionIdint64

History 3

SetDevProductInfoUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetPlayerOwnsAssetUrl

Parameters (1)
urlstring
Returns (1)
void

History 3

SetProductInfoUrl

Parameters (1)
urlstring
Returns (1)
void

History 3

SignalPromptSubscriptionCancellationFinished

Parameters (3)
playerInstance
subscriptionIdint64
wasCanceledbool
Returns (1)
null

History 4

Settings