2 min read

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

GamePassConfigV2 — game-passes-http-service/v1

Creator-facing representation of a game pass configuration.

Properties

NameTypeRequiredDescription
gamePassIdintegertrueThe game pass ID.
namestringtrueThe name of the game pass.
descriptionstringtrueThe description of the game pass.
isForSalebooleantrueWhether the game pass is currently on sale.
iconAssetIdintegertrueThe icon image (thumbnail) asset ID of the game pass.
createdTimestampstringtrueThe timestamp when the game pass was created.
updatedTimestampstringtrueThe timestamp when the game pass was last updated.
priceInformationtrueThe pricing configuration associated with the game pass.

Complete Schema

{
  "required": [
    "createdTimestamp",
    "description",
    "gamePassId",
    "iconAssetId",
    "isForSale",
    "name",
    "priceInformation",
    "updatedTimestamp"
  ],
  "type": "object",
  "properties": {
    "gamePassId": {
      "type": "integer",
      "description": "The game pass ID.",
      "format": "int64"
    },
    "name": {
      "type": "string",
      "description": "The name of the game pass."
    },
    "description": {
      "type": "string",
      "description": "The description of the game pass."
    },
    "isForSale": {
      "type": "boolean",
      "description": "Whether the game pass is currently on sale."
    },
    "iconAssetId": {
      "type": "integer",
      "description": "The icon image (thumbnail) asset ID of the game pass.",
      "format": "int64"
    },
    "createdTimestamp": {
      "type": "string",
      "description": "The timestamp when the game pass was created.",
      "format": "date-time"
    },
    "updatedTimestamp": {
      "type": "string",
      "description": "The timestamp when the game pass was last updated.",
      "format": "date-time"
    },
    "priceInformation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PriceInformationStruct"
        }
      ],
      "description": "The pricing configuration associated with the game pass.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Creator-facing representation of a game pass configuration."
}