Twitch.Sub

A new subscription.

• Platform: twitch
• Shape: sub
• Source event: Twitch.Sub

Usage

Widget.on("Twitch.Sub", (event) => {
  // event.user, event.platform…
});

Fields

• user (string): Display name; «Anonymous» for anonymous gifts.
• userId (string): User id on its platform.
• userLogin (string): Login, lowercase.
• tier (1 | 2 | 3): Subscription tier.
• prime (boolean): Whether it is a Prime sub.
• months (number): Always 1 for a new sub.

It also carries platform (the source platform) and raw (the original payload).

Example

The example payload that reaches the Studio simulator:

{
  "user": {
    "role": 1,
    "badges": [
      {
        "name": "subscriber",
        "version": "0",
        "imageUrl": "https://static-cdn.jtvnw.net/badges/v1/5d9f2208-5dd8-11e7-8513-2ff4adfae661/3",
        "info": "1"
      }
    ],
    "color": "#FF69B4",
    "subscribed": true,
    "subscriptionTier": "1000",
    "monthsSubscribed": 1,
    "id": "100000001",
    "login": "pixelpanda",
    "name": "PixelPanda",
    "type": "twitch"
  },
  "messageId": "00000000-0000-4000-8000-000000000004",
  "systemMessage": "PixelPanda subscribed at Tier 1.",
  "isTest": false,
  "broadcaster": {
    "id": "100000000",
    "login": "canaldeprueba",
    "name": "CanalDePrueba",
    "type": "twitch"
  },
  "isInSharedChat": false,
  "isSharedChatHost": false,
  "isFromSharedChatGuest": false,
  "createdAt": "2026-09-26T05:34:18.0934411Z",
  "subTier": "1000",
  "isPrime": false,
  "durationMonths": 1
}