PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. MarketplaceService

MarketplaceService

Show deprecated
Hide content
  1. apireference
  2. marketplaceservice

MarketplaceService

Show deprecated

MarketplaceService is the game service that is responsible for in-game transactions.

The most notable functions are MarketplaceService/PromptProductPurchase|PromptProductPurchase and MarketplaceService/PromptPurchase|PromptPurchase, as well as the callback MarketplaceService/ProcessReceipt|ProcessReceipt which must be well defined so that transactions do not fail.

MarketplaceService also has functions that fetch information about developer products (MarketplaceService/GetProductInfo|GetProductInfo and MarketplaceService/GetDeveloperProductsAsync|GetDeveloperProductsAsync), game passes (MarketplaceService/UserOwnsGamePassAsync|UserOwnsGamePassAsync), and other assets (MarketplaceService/PlayerOwnsAsset|PlayerOwnsAsset).

Monetization

Learning to use MarketplaceService is the first step towards learning to monetize a game on Roblox. Another important game service regarding monetization is DataStoreService which is responsible for saving and loading data like that of purchases.

See also

Properties

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Instance

GetDeveloperProductsAsync ( )

[Yields]

Returns a Pages object which contains information for all of the current game’s developer products.
Dictionary

GetProductInfo ( int64 assetId , InfoType infoType )

[Yields]

Returns the product information of an asset using its assetId
int

GetRobuxBalance ( )

[Yields]
bool

IsPlayerSubscribed ( Instance player , int64 subscriptionId )

[Yields]
Dictionary

PerformPurchase ( InfoType infoType , int64 productId , int expectedPrice , string requestId , bool isRobloxPurchase )

[Yields]
bool

PlayerCanMakePurchases ( Instance player )

bool

PlayerOwnsAsset ( Instance player , int64 assetId )

[Yields]

Returns whether the given player has the given asset.
void

PromptBundlePurchase ( Instance player , int64 bundleId )

Used to prompt a user to purchase a bundle with the given bundleId
void

PromptGamePassPurchase ( Instance player , int64 gamePassId )

Used to prompt a user to purchase a game pass with the given assetId.
void

PromptNativePurchase ( Instance player , string productId )

void

PromptPremiumPurchase ( Instance player )

Used to prompt a user to purchase Premium
void

PromptProductPurchase ( Instance player , int64 productId , bool equipIfPurchased , CurrencyType currencyType )

Used to prompt a user to purchase a product with the given product id.
void

PromptPurchase ( Instance player , int64 assetId , bool equipIfPurchased , CurrencyType currencyType )

Used to prompt a user to purchase an item with the given assetId.
void

PromptRobloxPurchase ( int64 assetId , bool equipIfPurchased )

void

PromptSubscriptionCancellation ( Instance player , int64 subscriptionId )

void

PromptSubscriptionPurchase ( Instance player , int64 subscriptionId )

void

PromptThirdPartyPurchase ( Instance player , string productId )

Prompts a third-party purchase.
void

ReportAssetSale ( string assetId , int robuxAmount )

void

ReportRobuxUpsellStarted ( )

void

SignalAssetTypePurchased ( Instance player , AssetType assetType )

void

SignalClientPurchaseSuccess ( string ticket , int64 playerId , int64 productId )

void

SignalMockPurchasePremium ( )

void

SignalPromptBundlePurchaseFinished ( Instance player , int64 bundleId , bool success )

void

SignalPromptGamePassPurchaseFinished ( Instance player , int64 gamePassId , bool success )

void

SignalPromptPremiumPurchaseFinished ( bool didTryPurchasing )

void

SignalPromptProductPurchaseFinished ( int64 userId , int64 productId , bool success )

void

SignalPromptPurchaseFinished ( Instance player , int64 assetId , bool success )

void

SignalPromptSubscriptionCancellationFinished ( Instance player , int64 subscriptionId , bool wasCanceled )

void

SignalPromptSubscriptionPurchaseFinished ( Instance player , int64 subscriptionId , bool wasPurchased )

void

SignalServerLuaDialogClosed ( bool value )

bool

UserOwnsGamePassAsync ( int64 userId , int64 gamePassId )

[Yields]

Returns true if the player with the given Player/UserId|UserId owns the game pass with the given game pass ID.

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given FullName (or partial FullName).
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

ClientLuaDialogRequested ( Tuple arguments )

RBXScriptSignal

ClientPurchaseSuccess ( string ticket , int64 playerId , int64 productId )

RBXScriptSignal

NativePurchaseFinished ( Instance player , string productId , bool wasPurchased )

RBXScriptSignal

PromptBundlePurchaseFinished ( Instance player , int64 bundleId , bool wasPurchased )

RBXScriptSignal

PromptBundlePurchaseRequested ( Instance player , int64 bundleId )

RBXScriptSignal

PromptGamePassPurchaseFinished ( Instance player , int64 gamePassId , bool wasPurchased )

Fires when a purchase prompt closes for a game pass
RBXScriptSignal

PromptGamePassPurchaseRequested ( Instance player , int64 gamePassId )

RBXScriptSignal

PromptPremiumPurchaseFinished ( )

Fires when the Premium purchase modal closes
RBXScriptSignal

PromptPremiumPurchaseRequested ( Instance player )

RBXScriptSignal

PromptProductPurchaseFinished ( int64 userId , int64 productId , bool isPurchased )

[Deprecated]

Fires when a purchase prompt closes for a developer product. Warning: do not use to process developer product purchases!
RBXScriptSignal

PromptProductPurchaseRequested ( Instance player , int64 productId , bool equipIfPurchased , CurrencyType currencyType )

RBXScriptSignal

PromptPurchaseFinished ( Instance player , int64 assetId , bool isPurchased )

Fires when a purchase prompt closes for an affiliate gear sale or other asset (does not fire for developer product or game pass prompts)
RBXScriptSignal

PromptPurchaseRequested ( Instance player , int64 assetId , bool equipIfPurchased , CurrencyType currencyType )

RBXScriptSignal

PromptRobloxPurchaseRequested ( int64 assetId , bool equipIfPurchased )

RBXScriptSignal

PromptSubscriptionCancellationFinished ( Instance player , int64 subscriptionId , bool wasCanceled )

RBXScriptSignal

PromptSubscriptionCancellationRequested ( Instance player , int64 subscriptionId )

RBXScriptSignal

PromptSubscriptionPurchaseFinished ( Instance player , int64 subscriptionId , bool wasPurchased )

RBXScriptSignal

PromptSubscriptionPurchaseRequested ( Instance player , int64 subscriptionId )

RBXScriptSignal

ServerPurchaseVerification ( Dictionary serverResponseTable )

RBXScriptSignal

ThirdPartyPurchaseFinished ( Instance player , string productId , string receipt , bool wasPurchased )

Fires when a third-party purchase has been completed.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Callback

ProductPurchaseDecision

ProcessReceipt ( Dictionary receiptInfo )

A callback to process receipts of product purchases.

Code Samples

Handling Gamepass Purchase Finished

Below is a screenshot of a game pass purchase prompt. The function in the code sample runs immediately after the player presses “Cancel” or after the player buys the game pass then presses “OK”. Should there be an issue with the purchase, the event also fires.

A game pass purchase prompt

Copy Code Light Theme
GamePassService Path