OBJECT

SubscriptionProduct

A subscription that is purchasable by users. Once purchased, the subscription entitles the user to use special emote sets on Twitch.

GraphQL Schema definition

1 type SubscriptionProduct {
2 
3 #   The subscription product's display name.
4 displayName: String 
5 
6 #   The maximum number of Emotes that can be associated with this product.
7 emoteLimit: Int 
8 
9 #   The maximum number of animated Emotes that can be associated with this product.
10 animatedEmoteLimit: Int 
11 
12 #   The emote modifiers associated with the product.
13 emoteModifiers: [EmoteModifier!] 
14 
15 #   The identifier of the static EmoteSet that a user gains access to use on Twitch,
16 #   when they purchase this product.
17 emoteSetID: ID @deprecated( reason: "Products can have more than one emote set now so use emoteGroups instead."  )
18 
19 #   The emote groups that the user gains access to use on Twitch when they purchase 
20 #   this product.
21 #   When using the ALL filter the data is uncached and should only be used on the 
22 #   creator dashboard.
23 emoteGroups(state: EmoteStateFilter): [EmoteSet!] 
24 
25 #   A list of Emotes the user gains access to use on Twitch when they purchase
26 #   this product.
27 emotes(state: EmoteStateFilter): [Emote] 
28 
29 #   A list of GiftOffers that are available on this subscription product
30 #   depending on which platform and gift type is given
31 #   Used by clients to display different gift prices, quantities and gift promotion 
32 #   information.
33 giftOffers(
34 platform: SubscriptionGiftOfferPlatform,
35 type: SubscriptionGiftType!
36 ): [SubscriptionGiftOffer!] 
37 
38 #   The subscription product's promotion if it is active.
39 giftPromotion: SubscriptionPromotion 
40 
41 #   The different types of gift subscriptions ("Community" vs "Standard").
42 gifting: SubscriptionGifting! 
43 
44 #   Whether the subscription hides ads for the channel.
45 hasAdFree: Boolean! 
46 
47 #   Whether the subscribers of this product are affected by slow chat mode.
48 hasFastChat: Boolean 
49 
50 #   Whether the channel has sub only chatroom restriction.
51 hasSubOnlyChat: Boolean 
52 
53 #   Whether the subscribers of this product are able to see the subs-only video 
54 #   archive.
55 hasSubonlyVideoArchive: Boolean 
56 
57 #   The subscription product's identifier.
58 id: ID! 
59 
60 #   The interval that the product lasts for. Includes unit + duration.
61 interval: SubscriptionInterval! 
62 
63 #   The subscription product's name.
64 name: String! 
65 
66 #   Available offers for a subscription product.
67 offers: [Offer!] 
68 
69 #   The Twitch user that is the owner of the channel associated with this 
70 #   subscription product.
71 #   This is null for SubscriptionProducts like 'turbo' that are not associated with 
72 #   any user.
73 owner: User 
74 
75 #   The subscription's USD-formatted price, e.g. "$9.99".
76 price: String! @deprecated( reason: "Transitioning to priceInfo instead to support multi region pricing"  )
77 
78 #   PriceInfo holds the products pricing information such as currency, cost, and tax 
79 #   information.
80 priceInfo(taxCountry: String): PriceInfo! 
81 
82 #   The subscription product's promotion if it is active.
83 promotion: SubscriptionPromotion 
84 
85 #   The currently active revenue configuration record for the subscription product.
86 revenueConfig: RevenueConfig 
87 
88 #   The connection for user to the subscription product.
89 self: SubscriptionProductSelfConnection 
90 
91 #   The avaliability state of the product. e.g. "active" or "inactive".
92 state: SubscriptionState! 
93 
94 #   ThirdPartytemplateSKU is used by the frontend to retrieve third party product 
95 #   information such
96 #   as price. templateSKU is exposed separately from purchaseSKU since retrieving 
97 #   purchaseSKU is a
98 #   more expensive operation. A user may not be able to purchase the templateSKU. 
99 #   Use purchaseSKU
100 #   when the user has indiciated they want to purchase.
101 #   Uses Client-ID to determine platform information and IP address to determine 
102 #   location.
103 thirdPartyTemplateSKU(platform: String): String 
104 
105 #   The tier of the product.
106 tier: String! 
107 
108 #   The type of subscription, e.g. "chansub" or "teamsub".
109 type: SubscriptionProductType! 
110 
111 #   The URL for this subscription's purchase page.
112 url: String! 
113 
114 }

1	type SubscriptionProduct {
2
3	# The subscription product's display name.
4	displayName: String
5
6	# The maximum number of Emotes that can be associated with this product.
7	emoteLimit: Int
8
9	# The maximum number of animated Emotes that can be associated with this product.
10	animatedEmoteLimit: Int
11
12	# The emote modifiers associated with the product.
13	emoteModifiers: [EmoteModifier!]
14
15	# The identifier of the static EmoteSet that a user gains access to use on Twitch,
16	# when they purchase this product.
17	emoteSetID: ID @deprecated( reason: "Products can have more than one emote set now so use emoteGroups instead." )
18
19	# The emote groups that the user gains access to use on Twitch when they purchase
20	# this product.
21	# When using the ALL filter the data is uncached and should only be used on the
22	# creator dashboard.
23	emoteGroups(state: EmoteStateFilter): [EmoteSet!]
24
25	# A list of Emotes the user gains access to use on Twitch when they purchase
26	# this product.
27	emotes(state: EmoteStateFilter): [Emote]
28
29	# A list of GiftOffers that are available on this subscription product
30	# depending on which platform and gift type is given
31	# Used by clients to display different gift prices, quantities and gift promotion
32	# information.
33	giftOffers(
34	platform: SubscriptionGiftOfferPlatform,
35	type: SubscriptionGiftType!
36	): [SubscriptionGiftOffer!]
37
38	# The subscription product's promotion if it is active.
39	giftPromotion: SubscriptionPromotion
40
41	# The different types of gift subscriptions ("Community" vs "Standard").
42	gifting: SubscriptionGifting!
43
44	# Whether the subscription hides ads for the channel.
45	hasAdFree: Boolean!
46
47	# Whether the subscribers of this product are affected by slow chat mode.
48	hasFastChat: Boolean
49
50	# Whether the channel has sub only chatroom restriction.
51	hasSubOnlyChat: Boolean
52
53	# Whether the subscribers of this product are able to see the subs-only video
54	# archive.
55	hasSubonlyVideoArchive: Boolean
56
57	# The subscription product's identifier.
58	id: ID!
59
60	# The interval that the product lasts for. Includes unit + duration.
61	interval: SubscriptionInterval!
62
63	# The subscription product's name.
64	name: String!
65
66	# Available offers for a subscription product.
67	offers: [Offer!]
68
69	# The Twitch user that is the owner of the channel associated with this
70	# subscription product.
71	# This is null for SubscriptionProducts like 'turbo' that are not associated with
72	# any user.
73	owner: User
74
75	# The subscription's USD-formatted price, e.g. "$9.99".
76	price: String! @deprecated( reason: "Transitioning to priceInfo instead to support multi region pricing" )
77
78	# PriceInfo holds the products pricing information such as currency, cost, and tax
79	# information.
80	priceInfo(taxCountry: String): PriceInfo!
81
82	# The subscription product's promotion if it is active.
83	promotion: SubscriptionPromotion
84
85	# The currently active revenue configuration record for the subscription product.
86	revenueConfig: RevenueConfig
87
88	# The connection for user to the subscription product.
89	self: SubscriptionProductSelfConnection
90
91	# The avaliability state of the product. e.g. "active" or "inactive".
92	state: SubscriptionState!
93
94	# ThirdPartytemplateSKU is used by the frontend to retrieve third party product
95	# information such
96	# as price. templateSKU is exposed separately from purchaseSKU since retrieving
97	# purchaseSKU is a
98	# more expensive operation. A user may not be able to purchase the templateSKU.
99	# Use purchaseSKU
100	# when the user has indiciated they want to purchase.
101	# Uses Client-ID to determine platform information and IP address to determine
102	# location.
103	thirdPartyTemplateSKU(platform: String): String
104
105	# The tier of the product.
106	tier: String!
107
108	# The type of subscription, e.g. "chansub" or "teamsub".
109	type: SubscriptionProductType!
110
111	# The URL for this subscription's purchase page.
112	url: String!
113
114	}

SubscriptionProduct

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by