OBJECT
SubscriptionBenefit
Data about a user's subscription to a broadcaster.
link GraphQL Schema definition
1 type SubscriptionBenefit { 2 3 # The date that the subscription benefit ends. 4 : Time 5 6 # gift resolves gift info about a SubscriptionBenefit. 7 : SubscriptionGift 8 9 # The unique identifier. 10 : ID! 11 12 # For a recurring subscription, the price is charged at every interval i months. 13 : Int! 14 15 # Whether the sub is set to "do not renew". 16 : Boolean! 17 18 # Whether this subscription has been extended. This means that a non-recurring 19 # subscription has been extended with additional months. 20 : Boolean! 21 22 # Whether the subscription is in the grace period to be cancelled and refunded. 23 : Boolean! 24 25 # The id of where the subscription originated from. Used when DNRing a recurring 26 # subscription. 27 : String 28 29 # If the subscriptionBenefit has a future dated paid upgrade. (ie. a user has 30 # upgraded a 1-month gift to a recurring subscription). 31 : PaidUpgrade @deprecated( reason: "gift to paid upgrades will now be in the pendingSubscription schema" ) 32 33 # If the subscriptionBenefit has a pending future dated paid subscription. 34 : PendingSubscription 35 36 # The platform the subscription was purchased on. 37 : SubscriptionPlatform! 38 39 # Resolves the product that the subscription benefit is to. 40 : SubscriptionProduct 41 42 # Whether this benefit was achieved using a Twitch Prime subscription. 43 : Boolean! 44 45 # The date that the subscription benefit will renew. Will be nil if the 46 # subscription benefit 47 # is not going to renew. 48 : Time 49 50 # The states this benefit has transitioned through. Captures both user-initiated 51 # states 52 # such as initiating a DNR request, as well as system-initiated states such as 53 # completing a DNR request. 54 : [SubscriptionBenefitStateHistory!] 55 56 # Exposes the third party SKU for managing third party subscriptions from the 57 # client. 58 # Will be nil if there is not a thirdPartySKU associated with this subscription 59 # benefit. 60 : String 61 62 # The subscription tier. 63 : String! 64 65 # The user who is subscribed to. 66 : User 67 68 }
link Required by
- PurchaseProfilePurchase profile of a recurring or non-recurring subscription that a user bought.
- RecurringPaymentDetailPayment Method information for a recurring payment. An abstraction for a set of Payments models, existing here to surface to the Payments Management Page.
- SpendSubscriptionCreditPayloadMutated data after spending the subscription credit.
- SubscriptionBenefitEdgeAn element in a paginated list of subscription benefits.
- SubscriptionProductSelfConnectionThe connection between the user and subscription product.
- UserRelationshipSubjective data on a User (user/channel) for the target user.
- UserSelfConnectionSubjective data on another User (user/channel) for the current user.