Skip to main content

Subscriptions

FunctionReturns
getSubscriptionsPromise<PaginatedSubscriptionsResult>
getSubscriptionsForUsersPromise<Array<Subscription>>
getSubscriptionForUserPromise<Subscription | null>
checkUserSubscriptionPromise<UserSubscription | null>

Functions​

getSubscriptions​

twitch.subscription.getSubscriptions(pagination?: ForwardPagination): Promise<PaginatedSubscriptionsResult>

getSubscriptionsForUsers​

twitch.subscription.getSubscriptionsForUsers(userIds: Array<UserIdResolvable>): Promise<Array<Subscription>>

getSubscriptionForUser​

twitch.subscription.getSubscriptionForUser(userId: UserIdResolvable): Promise<Subscription | null>

checkUserSubscription​

twitch.subscription.checkUserSubscription(userId: UserIdResolvable, broadcasterId: UserIdResolvable): Promise<UserSubscription | null>

Types​

ForwardPagination​

type ForwardPagination = {
	limit?: number
	after?: string
}

PaginatedSubscriptionsResult​

type PaginatedSubscriptionsResult = {
	points: number
	data: Array<Subscription>
	cursor: string
	total: number
}

Subscription​

type Subscription = {
	gifterId: string
	gifterLogin: string
	gifterName: string
	planName: string
	userId: string
	userLogin: string
	userName: string
	message?: string
	broadcasterId: string
	broadcasterLogin: string
	broadcasterName: string
	isGift: boolean
	tier: string
}

UserIdResolvable​

type UserIdResolvable = string | UserIdResolvableType

UserIdResolvableType​

type UserIdResolvableType = {
	id: string
}

UserSubscription​

type UserSubscription = {
	broadcasterId: string
	broadcasterLogin: string
	broadcasterName: string
	isGift: boolean
	tier: string
}