CreatorStoreProduct

Represents a product in the Creator Store. This resource is used to manage distribution and pricing of assets on the Creator Store.

Attributes

pathstring

The resource path of the creator store product.

Format: creator-store-products/{creator_store_product_id}.

basePriceobject

The base price of the product. For more information, see Money. Each product type (such as pluginAssetId) supports a set of specific prices. Currently, only setting a base price in USD is supported.

Depending on type, each Creator Store product has a fixed set of supported prices; see the productType attribute for the full list. For example, to set the price of a plugin to $4.99, use the following base price:


"basePrice": {
  "currencyCode": "USD",
  "quantity": {
    "significand": 4990000000,
    "exponent": -9
  }
}

Note: The exponent must be -9, and the significand must be in this format. The corresponding Decimal format is significand * 10^exponent.

If you want to set the price of a plugin to $0 (i.e. free), use the following base_price


"basePrice": {
  "currencyCode": "USD",
  "quantity": {
    "significand": 0,
    "exponent": 0
  }
}

Note: You must still set the currencyCode to USD, even for free products.

The actual purchase price is based on this base price, but often differs slightly due to locale-specific considerations.

Set this to zero to make the product free.

purchasePriceobject

The effective purchase price for the user, after factoring in locale-specific considerations.

publishedboolean

Whether the seller intends to distribute the Creator Store product on the Creator Store. A seller might intend to distribute a product, but due to some restrictions on the seller or underlying Creator Store product, the product may not be available for purchase. See restrictions and purchasable for more details.

restrictionsarray<enum>

Output Only

Restrictions applied to the product. A product can have multiple restrictions active at one time.

Possible values:

Value	Description
RESTRICTION_UNSPECIFIED	Unspecified restriction.
SOLD_ITEM_RESTRICTED	The item being sold has been restricted by Roblox Details may be available by looking up that item directly.
SELLER_TEMPORARILY_RESTRICTED	The product is restricted because the seller's account is temporarily restricted by Roblox.
SELLER_PERMANENTLY_RESTRICTED	The product is restricted because the seller's account is permanently restricted by Roblox.
SELLER_NO_LONGER_ACTIVE	The product is restricted because the seller's account was deleted or is otherwise no longer active.

purchasableboolean

Output Only

Whether the product is purchasable.

For this value to be true, published must be true and restrictions must be empty. If this value is false, the product may not be acquired by any user.

One of the following for seller:

userSellerstring

Output Only

The Roblox user selling the product.

groupSellerstring

Output Only

The Roblox group selling the product.

One of the following for productType:

modelAssetIdstring

Immutable

The Creator Store product is a model with this asset ID.

pluginAssetIdstring

Immutable

The Creator Store product is a plugin with this asset ID.

Supported base prices in USD: $0, $4.99, $5.99, $6.99, $7.99, $8.99, $9.99, $10.99, $11.99, $12.99, $13.99, $14.99, $15.99, $16.99, $17.99, $18.99, $19.99, $24.99, $29.99, $34.99, $39.99, $44.99, $49.99, $59.99, $69.99, $79.99, $89.99, $99.99, $149.99, $199.99, $249.99.

audioAssetIdstring

Immutable

The Creator Store product is an audio file with this asset ID.

decalAssetIdstring

Immutable

The Creator Store product is a decal with this asset ID.

meshPartAssetIdstring

Immutable

The Creator Store product is a mesh part with this asset ID.

videoAssetIdstring

Immutable

The Creator Store product is a video with this asset ID.

fontFamilyAssetIdstring

Immutable

The Creator Store product is a font family with this asset ID.

Base URL

https://apis.roblox.com

The CreatorStoreProduct Resource

{
  "path": "creator-store-products/123",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": [
    "RESTRICTION_UNSPECIFIED"
  ],
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Create Creator Store Product
Beta

POST /cloud/v2/creator-store-products

Add a Creator Store product. Only use this method if your product has never been distributed on the Creator Store; otherwise, use the PATCH method to update the product.

Scopes

creator-store-product:write

RequestRequest BodyCreatorStoreProduct

ResponseCreatorStoreProduct

POST /cloud/v2/creator-store-products

curl -L -X POST 'https://apis.roblox.com/cloud/v2/creator-store-products' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "modelAssetId": "string"
}'

Response

{
  "path": "creator-store-products/123",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": [
    "RESTRICTION_UNSPECIFIED"
  ],
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Get Creator Store Product
Beta

GET /cloud/v2/creator-store-products/{creator_store_product_id}

Get a Creator Store product.

Scopes

creator-store-product:read

RequestPath Parameters

creator_store_product_idstring

Required

The creator-store-product ID.

ResponseCreatorStoreProduct

GET /cloud/v2/creator-store-products/{creator_store_product_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/creator-store-products/{creator_store_product_id}' \
  -H 'x-api-key: {your-api-key}'

Response

{
  "path": "creator-store-products/123",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": [
    "RESTRICTION_UNSPECIFIED"
  ],
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Update Creator Store Product
Beta

PATCH /cloud/v2/creator-store-products/{creator_store_product_id}

Update a Creator Store product.

Scopes

creator-store-product:write

RequestPath Parameters

creator_store_product_idstring

Required

The creator-store-product ID.

Query Parameters

updateMaskstring

The list of fields to update. This string is formatted as a FieldMask.

allowMissingboolean

If set to true, and the creator store product is not found, a creator store product is created. In this situation, update_mask is ignored.

Request BodyCreatorStoreProduct

ResponseCreatorStoreProduct

PATCH /cloud/v2/creator-store-products/{creator_store_product_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/creator-store-products/{creator_store_product_id}?updateMask={string}&allowMissing={boolean}' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true
}'

Response

{
  "path": "creator-store-products/123",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": [
    "RESTRICTION_UNSPECIFIED"
  ],
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Attributes

CreatorStoreProduct

Create Creator Store ProductBeta

CreatorStoreProduct

Get Creator Store ProductBeta

CreatorStoreProduct

Update Creator Store ProductBeta

Create Creator Store Product
Beta

Get Creator Store Product
Beta

Update Creator Store Product
Beta