subscription
subscription events are fired when a user subscribes to a channel for the first time.
Kind: global variable
Parameters
| Param | Type | Default | Description |
|---|---|---|---|
| color | string | The color of the user's name in chat. | |
| messageid | string | The ID of the message. | |
| prime | boolean | false | Whether this is a Prime subscription. |
| tier | number | 1 | The tier of the subscription being extended. |
| timestamp | string | The millisecond timestamp when the message was sent. | |
| userid | string | The ID of the user sending the message. | |
| username | string | The username of the user sending the message. |
Examples
Fires a `subscription` event
Simulates a Prime `subscription` event
Simulates a Tier 3 `subscription` event