7 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

CreatorStoreProduct — openapi

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

Properties

Related Schemas

• Money

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "creator-store-products/123",
      "type": "string",
      "description": "The resource path of the creator store product.\n\nFormat: `creator-store-products/{creator_store_product_id}`"
    },
    "basePrice": {
      "$ref": "#/components/schemas/Money",
      "description": "The base price of the product. For more information, see\n[Money](/cloud/reference/types.md#money). Each product type (such as\n`pluginAssetId`) supports a set of specific prices. Currently, only setting\na base price in USD is supported.\n\nDepending on type, each Creator Store product has a fixed set of supported\nprices; see the `productType` attribute for the full list. For example, to\nset the price of a plugin to $4.99, use the following base price:\n```\n\"basePrice\": {\n  \"currencyCode\": \"USD\",\n  \"quantity\": {\n    \"significand\": 4990000000,\n    \"exponent\": -9\n  }\n}\n```\n\nNote: The exponent **must** be -9, and the significand must be in this\nformat. The corresponding [Decimal](/cloud/reference/types.md#decimal)\nformat is `significand * 10^exponent`.\n\nIf you want to set the price of a plugin to $0 (i.e. free), use the\nfollowing `base_price`\n\n```\n\"basePrice\": {\n  \"currencyCode\": \"USD\",\n  \"quantity\": {\n    \"significand\": 0,\n    \"exponent\": 0\n  }\n}\n```\n\nNote: You must still set the `currencyCode` to USD, even for\nfree products.\n\nThe actual purchase price is based on this base price, but often differs\nslightly due to locale-specific considerations.\n\nSet this to zero to make the product free."
    },
    "purchasePrice": {
      "$ref": "#/components/schemas/Money",
      "description": "The effective purchase price for the user, after factoring in\nlocale-specific considerations."
    },
    "published": {
      "example": true,
      "type": "boolean",
      "description": "Whether the seller intends to distribute the Creator Store product on\nthe Creator Store. A seller might intend to distribute a product, but due\nto some restrictions on the seller or underlying Creator Store product, the\nproduct may not be available for purchase. See\n`restrictions` and `purchasable` for more details."
    },
    "restrictions": {
      "readOnly": true,
      "type": "array",
      "items": {
        "example": "RESTRICTION_UNSPECIFIED",
        "enum": [
          "RESTRICTION_UNSPECIFIED",
          "SOLD_ITEM_RESTRICTED",
          "SELLER_TEMPORARILY_RESTRICTED",
          "SELLER_PERMANENTLY_RESTRICTED",
          "SELLER_NO_LONGER_ACTIVE"
        ],
        "type": "string",
        "format": "enum"
      },
      "description": "Restrictions applied to the product. A product can have multiple\nrestrictions active at one time.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | RESTRICTION_UNSPECIFIED | Unspecified restriction. |\n  | SOLD_ITEM_RESTRICTED | The item being sold has been restricted by Roblox  Details may be available by looking up that item directly. |\n  | SELLER_TEMPORARILY_RESTRICTED | The product is restricted because the seller's account is temporarily restricted by Roblox. |\n  | SELLER_PERMANENTLY_RESTRICTED | The product is restricted because the seller's account is permanently restricted by Roblox. |\n  | SELLER_NO_LONGER_ACTIVE | The product is restricted because the seller's account was deleted or is otherwise no longer active. |"
    },
    "purchasable": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "Whether the product is purchasable.\n\nFor this value to be true, `published` must be true and `restrictions` must\nbe empty. If this value is false, the product may not be acquired by any\nuser."
    },
    "userSeller": {
      "readOnly": true,
      "type": "string",
      "description": "The Roblox user selling the product."
    },
    "groupSeller": {
      "readOnly": true,
      "type": "string",
      "description": "The Roblox group selling the product."
    },
    "modelAssetId": {
      "type": "string",
      "description": "The Creator Store product is a model with this asset ID.",
      "x-immutable": true
    },
    "pluginAssetId": {
      "type": "string",
      "description": "The Creator Store product is a plugin with this asset ID.\n\nSupported base prices in USD: $0, $4.99, $5.99, $6.99, $7.99, $8.99,\n$9.99, $10.99, $11.99, $12.99, $13.99, $14.99, $15.99, $16.99, $17.99,\n$18.99, $19.99, $24.99, $29.99, $34.99, $39.99, $44.99, $49.99, $59.99,\n$69.99, $79.99, $89.99, $99.99, $149.99, $199.99, $249.99",
      "x-immutable": true
    },
    "audioAssetId": {
      "type": "string",
      "description": "The Creator Store product is an audio file with this asset ID.",
      "x-immutable": true
    },
    "decalAssetId": {
      "type": "string",
      "description": "The Creator Store product is a decal with this asset ID.",
      "x-immutable": true
    },
    "meshPartAssetId": {
      "type": "string",
      "description": "The Creator Store product is a mesh part with this asset ID.",
      "x-immutable": true
    },
    "videoAssetId": {
      "type": "string",
      "description": "The Creator Store product is a video with this asset ID.",
      "x-immutable": true
    },
    "fontFamilyAssetId": {
      "type": "string",
      "description": "The Creator Store product is a font family with this asset ID.",
      "x-immutable": true
    }
  },
  "description": "Represents a product in the Creator Store. This resource is used to manage\ndistribution and pricing of assets on the Creator Store.",
  "x-aep-resource": {
    "patterns": [
      "creator-store-products/{creator_store_product_id}"
    ],
    "plural": "creator-store-products",
    "singular": "creator-store-product"
  },
  "x-resource": true,
  "x-oneOf": {
    "productType": [
      "modelAssetId",
      "pluginAssetId",
      "audioAssetId",
      "decalAssetId",
      "meshPartAssetId",
      "videoAssetId",
      "fontFamilyAssetId"
    ],
    "seller": [
      "userSeller",
      "groupSeller"
    ]
  }
}