{}
The display name of the subscribing user.
displayName: string
The duration of the gifted subscription, in months.
giftDuration: number
The name of the user that gifted the subscription.
gifter?: string
The display name of the user that gifted the subscription.
gifterDisplayName?: string
The number of subscriptions the gifting user has already gifted in total.
gifterGiftCount?: number
The user ID of the user that gifted the subscription.
gifterUserId?: string
Whether the subscription was "paid" for with Twitch Prime.
isPrime: boolean
The message that was sent with the subscription.
message?: string
The number of total months of subscriptions for the channel.
months: number
The info about the original gift of the subscription, when renewing a multi-month gift.
The plan ID of the subscription.
plan: string
The plan name of the subscription.
planName: string
The number of consecutive months of subscriptions for the channel.
streak?: number
The user ID of the subscribing user.
userId: string
Properties
gifterGiftCount
Type: ?number
The number of subscriptions the gifting user has already gifted in total.
originalGiftInfo
Type: ?ChatSubOriginalGiftInfo
The info about the original gift of the subscription, when renewing a multi-month gift.
plan
Type: string
The plan ID of the subscription.
Tier 1, 2, 3 are '1000', '2000', '3000' respectively, and a Twitch Prime subscription is called 'Prime'.
streak
Type: ?number
The number of consecutive months of subscriptions for the channel.
Will not be sent if the user resubscribing does not choose to.