Skip to content

Commit ed1aceb

Browse files
author
github-actions
committed
Update reference.
1 parent 91583ef commit ed1aceb

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

.roar/Docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12751,7 +12751,7 @@
1275112751
"GetRobloxSubscriptionDetailsAsync": {},
1275212752
"GetSubscriptionProductInfoAsync": {
1275312753
"Summary": "<p>Returns the product information of a subscription for the given\n<code>subscriptionId</code>.</p>\n",
12754-
"Description": "<p><strong>Note</strong>: Because it returns a localized price, you can only call this\nmethod from a <a href=\"/ref/class/Script.html\">Script</a> with <a href=\"/ref/enum/RunContext.html\">RunContext.Client</a>.</p>\n<p>Returns the product information of a subscription for the given\n<code>subscriptionId</code>.</p>\n<table size=\"small\">\n\t<thead>\n\t <tr>\n\t <th>Key</th>\n\t <th>Type</th>\n\t <th>Description</th>\n\t </tr>\n\t</thead>\n <tbody>\n\t<tr>\n\t <td><code>Name</code></td>\n\t <td>string</td>\n\t <td>The name of the subscription product.</td>\n </tr>\n\t<tr>\n\t <td><code>Description</code></td>\n\t <td>string</td>\n\t <td>The description of the subscription product.</td>\n </tr>\n\t<tr>\n\t <td><code>IconImageAssetId</code></td>\n\t <td>number</td>\n <td>The asset ID of the subscription product icon.</td>\n </tr>\n\t<tr>\n\t <td><code>SubscriptionPeriod</code></td>\n\t <td><a href=\"/ref/enum/SubscriptionPeriod.html\">SubscriptionPeriod</a></td>\n <td>The duration of the subscription (for example, <code>Month</code>, <code>Year</code>, etc.).</td>\n </tr>\n\t<tr>\n\t <td><code>DisplayPrice</code></td>\n\t <td>string</td>\n <td>Localized price with the appropriate currency symbol for display (for example, <code>$4.99</code>). For users in unsupported countries, <code>DisplayPrice</code> returns a string without specific price information.</td>\n </tr>\n\t<tr>\n\t <td><code>DisplaySubscriptionPeriod</code></td>\n\t <td>string</td>\n <td>Localized subscription period text for display (for example, <code>/month</code>). Can be used together with <code>DisplayPrice</code>.</td>\n </tr>\n\t<tr>\n\t <td><code>SubscriptionProviderName</code></td>\n\t <td>string</td>\n <td>Name of the subscription benefit provider (for example, the name of the associated experience).</td>\n </tr>\n\t<tr>\n\t <td><code>IsForSale</code></td>\n\t <td>boolean</td>\n\t <td>True if the subscription product is available for sale.</td>\n </tr>\n <tr>\n\t <td><code>PriceTier</code></td>\n\t <td>number</td>\n\t <td>A number that can be used to compare the price of different subscription products. This is not the actual price of the subscription (for example, 499).</td>\n </tr>\n <tr>\n\t <td><code>PriceInRobux</code></td>\n\t <td>number</td>\n\t <td>The equivalent cost of the subscription in Robux. Returns 0 if the subscription product is not available to be purchased in Robux.</td>\n </tr>\n </tbody>\n</table>\n"
12754+
"Description": "<p><strong>Note</strong>: Because it returns a localized price, you can only call this\nmethod from a <a href=\"/ref/class/Script.html\">Script</a> with <a href=\"/ref/enum/RunContext.html\">RunContext.Client</a>.</p>\n<p>Returns the product information of a subscription for the given\n<code>subscriptionId</code>.</p>\n<table size=\"small\">\n\t<thead>\n\t <tr>\n\t <th>Key</th>\n\t <th>Type</th>\n\t <th>Description</th>\n\t </tr>\n\t</thead>\n <tbody>\n\t<tr>\n\t <td><code>Name</code></td>\n\t <td>string</td>\n\t <td>The name of the subscription product.</td>\n </tr>\n\t<tr>\n\t <td><code>Description</code></td>\n\t <td>string</td>\n\t <td>The description of the subscription product.</td>\n </tr>\n\t<tr>\n\t <td><code>IconImageAssetId</code></td>\n\t <td>number</td>\n <td>The asset ID of the subscription product icon.</td>\n </tr>\n\t<tr>\n\t <td><code>SubscriptionPeriod</code></td>\n\t <td><a href=\"/ref/enum/SubscriptionPeriod.html\">SubscriptionPeriod</a></td>\n <td>The duration of the subscription (for example, <code>Month</code>, <code>Year</code>, etc.).</td>\n </tr>\n\t<tr>\n\t <td><code>DisplayPrice</code></td>\n\t <td>string</td>\n <td>Localized price with the appropriate currency symbol for display (for example, <code>$4.99</code>). For users in unsupported countries, <code>DisplayPrice</code> returns a string without specific price information.</td>\n </tr>\n\t<tr>\n\t <td><code>DisplaySubscriptionPeriod</code></td>\n\t <td>string</td>\n <td>Localized subscription period text for display (for example, <code>/month</code>). Can be used together with <code>DisplayPrice</code>.</td>\n </tr>\n\t<tr>\n\t <td><code>SubscriptionProviderName</code></td>\n\t <td>string</td>\n <td>Name of the subscription benefit provider (for example, the name of the associated experience).</td>\n </tr>\n\t<tr>\n\t <td><code>IsForSale</code></td>\n\t <td>boolean</td>\n\t <td>True if the subscription product is available for sale.</td>\n </tr>\n <tr>\n\t <td><code>PriceTier</code></td>\n\t <td>number</td>\n\t <td>A number that can be used to compare the price of different subscription products. This is not the actual price of the subscription (for example, 499).</td>\n </tr>\n <tr>\n \t <td><code>PriceInRobux</code></td>\n \t <td>number</td>\n \t <td>The equivalent cost of the subscription in Robux. Returns 0 if the subscription product is not available to be purchased in Robux.</td>\n </tr>\n </tbody>\n</table>\n"
1275512755
},
1275612756
"GetUserSubscriptionDetailsAsync": {
1275712757
"Summary": "<p>Returns a table that contains the details of the user&#39;s subscription for a\ngiven <code>subscriptionId</code>.</p>\n",

stats.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)