OBJECT

PurchaseProfile

Purchase profile of a recurring or non-recurring subscription that a user bought.

link GraphQL Schema definition

1type PurchaseProfile {
2
3# Cancels the entitled benefit and refunds if isRefundable is true.
4cancelledAt: Time
5
6# Date this purchase profile was created.
7createdAt: Time!
8
9expiresAt: Time
10
11# Usually the Twitch user's ID, but recorded by the payment provider.
12extPurchaserID: ID
13
14# The external subscription ID recorded by the payment provider.
15extSubscriptionID: ID
16
17# ID of the Purchase Profile in Payments team database.
18id: ID!
19
20isExpired: Boolean
21
22# Whether this purchase profile was gifted.
23isGift: Boolean
24
25# Whether this purchase profile is being paid for.
26isPaying: Boolean!
27
28isRecurring: Boolean!
29
30isRefundable: Boolean
31
32paidAt: Time
33
34# Product type of the purchase.
35productType: SubscriptionProductType!
36
37purchasedAt: Time
38
39# Twitch purchaser's email.
40purchaserEmail: String!
41
42# Twitch purchaser's user ID.
43purchaserID: ID!
44
45# Twitch purchaser's real name.
46purchaserName: String
47
48# Currency for the renewalPrice, e.g. "USD".
49renewalCurrency: String
50
51# Expected renewal price of the product in the smallest subunit of the currency,
52# e.g. "499".
53renewalPrice: Int
54
55# Different from cancellation in that it stops renewal but let's user keep the
56# benefit until it expires.
57renewalStoppedAt: Time
58
59# State of the purchase profile. i.e. cancelling the purchase profile can set
60# state to 'cancelled'.
61state: PurchaseProfileState!
62
63# Subscription benefit associated with this purchase profile, if still active.
64subscriptionBenefit: SubscriptionBenefit
65
66# Date this purchase profile was last updated.
67updatedAt: Time
68
69# Whether this purchase profile will renew in the future and charge the user's
70# payment method.
71willRenew: Boolean!
72
73}