PubSubSubscriptionMessage

Properties

• cumulativeMonths
• duration
• gifterDisplayName
• gifterId
• gifterName
• isAnonymous
• isGift
• isResub
• message
• months
• streakMonths
• subPlan
• time
• userDisplayName
• userId
• userName

The cumulative amount of months the user has been subscribed for.

Returns the months if a gift sub or the cumulative months.

The duration of subscription, in months.

This refers to first-time subscriptions, auto-renewal subscriptions, re-subscriptions, or gifted subscriptions.

The display name of the user gifting the subscription.

Returns null if the subscription is not a gift.

The ID of the user gifting the subscription.

Returns null if the subscription is not a gift.

The name of the user gifting the subscription.

Returns null if the subscription is not a gift.

Whether the subscription is from an anonymous gifter.

Whether the subscription is a gift.

Whether the subscription is a resub.

The message sent with the subscription.

Returns null if the subscription is a gift subscription.

The cumulative amount of months the user has been subscribed for.

Returns the months if a gift sub or the cumulative months.

The streak amount of months the user has been subscribed for.

Returns 0 if a gift sub or the streaks months.

The plan of the subscription.

The time the user subscribed.

The display name of the user subscribing to the channel.

The ID of the user subscribing to the channel.

The name of the user subscribing to the channel.