twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks

ChatSubGiftInfo

Information about a subscription that was gifted.

{
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.
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 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

displayName

Type: string

The display name of the subscribing user.

giftDuration

Type: number

The duration of the gifted subscription, in months.

gifter

Type: ?string

The name of the user that gifted the subscription.

gifterDisplayName

Type: ?string

The display name of the user that gifted the subscription.

gifterGiftCount

Type: ?number

The number of subscriptions the gifting user has already gifted in total.

gifterUserId

Type: ?string

The user ID of the user that gifted the subscription.

isPrime

Type: boolean

Whether the subscription was "paid" for with Twitch Prime.

message

Type: ?string

The message that was sent with the subscription.

months

Type: number

The number of total months of subscriptions for the channel.

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'.

planName

Type: string

The plan name of the subscription.

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.

userId

Type: string

The user ID of the subscribing user.