Reference API Roblox

Engine API

Website

Related

Reference API Roblox

CommerceService

Supports real-world purchases that you can bundle with digital benefits.

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 12

HistoryMember
649GetCommerceProductInfoAsync(commerceProductId: string): Dictionary
649PrepareCommerceProductPurchase(commerceProductId: string): Dictionary
649PromptCommerceProductPurchase(user: Player, commerceProductId: string): null
620PromptRealWorldCommerceBrowser(player: Player, url: string): null
649SignalPromptCommerceProductPurchaseFinished(productId: string, didTryPurchase: bool, checkoutSessionId: string = ): null
620UserEligibleForRealWorldCommerceAsync(): bool
649BenefitStatusReceived(isGranted: bool)
649FetchReceipt()
620InExperienceBrowserRequested(url: string)
649PromptCommerceProductPurchaseFinished(user: Player, productId: string)
649PromptCommerceProductPurchaseRequested(commerceProductId: string)
649PurchaseBrowserClosed()
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
616UniqueId: UniqueId
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
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

CommerceService is a service that supports real-world purchases that you can bundle with virtual items. For information on eligibility and implementation, see Commerce products.

History 19

Members 12

BenefitStatusReceived

Parameters (1)
isGrantedbool

History 1

FetchReceipt

Parameters (0)
No parameters.

History 1

GetCommerceProductInfoAsync

Parameters (1)
commerceProductIdstring
Returns (1)
Dictionary

Retrieves information about the products that you are selling and surface them within your experience. How you surface products to your users is entirely up to you.

NamestringLocalized name of of the physical item
DescriptionstringLocalized description of the physical item
IconImageAssetIdnumberThe image asset id of main default image of the physical item
DisplayPricestringLocalized price string with currency symbol of the physical item. e.g. “$4.99“
IsPurchasableboolIf the item can be added to a merchant checkout session, i.e. item is in stock, or can be backordered
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

InExperienceBrowserRequested

Parameters (1)
urlstring

History 1

PrepareCommerceProductPurchase

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

History 1

Tags: [Yields]

PromptCommerceProductPurchase

Parameters (2)
userPlayer
commerceProductIdstring
Returns (1)
null

Prompts a user to purchase a commerce product using the provided commerceProductId. Opens a webview that guides the user through the purchasing flow.

History 2

PromptCommerceProductPurchaseFinished

Parameters (2)
userPlayer
productIdstring

Use this signal to detect when a user has completed the purchasing flow and the webview has closed to resume gameplay within the experience. This signal does not indicate a successful purchase, so do not grant virtual items solely from this signal.

While optional, it is recommended to use this signal to reorient your users on Android, as the commerce purchasing flow will have forced them into portrait mode.

History 2

PromptCommerceProductPurchaseRequested

Parameters (1)
commerceProductIdstring

History 4

PromptRealWorldCommerceBrowser

Parameters (2)
playerPlayer
urlstring
Returns (1)
null

This is a legacy endpoint that is not meant for use. To open the webview to the purchasing flow for real world commerce, see CommerceService:PromptCommerceProductPurchase. For more information, see Commerce products

History 1

PurchaseBrowserClosed

Parameters (0)
No parameters.

History 1

SignalPromptCommerceProductPurchaseFinished

Parameters (3)Default
productIdstring
didTryPurchasebool
checkoutSessionIdstring
Returns (1)
null

History 1

UserEligibleForRealWorldCommerceAsync

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

This is a legacy endpoint that is not meant for use. To check if a user is eligible for real world commerce, see PolicyService.IsEligibleToPurchaseCommerceProduct. For more information, see Commerce products

This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

Settings