SubscriptionPurchase class
A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
Constructors
Properties
- acknowledgementState ↔ int
-
The acknowledgement state of the subscription product. Possible values
are: 0. Yet to be acknowledged 1. Acknowledged
read / write
- autoRenewing ↔ bool
-
Whether the subscription will automatically be renewed when it reaches its
current expiry time.
read / write
- autoResumeTimeMillis ↔ String
-
Time at which the subscription will be automatically resumed, in
milliseconds since the Epoch. Only present if the user has requested to
pause the subscription.
read / write
- cancelReason ↔ int
-
The reason why a subscription was canceled or is not auto-renewing.
Possible values are: 0. User canceled the subscription 1. Subscription was
canceled by the system, for example because of a billing problem 2.
Subscription was replaced with a new subscription 3. Subscription was
canceled by the developer
read / write
- cancelSurveyResult ↔ SubscriptionCancelSurveyResult
-
Information provided by the user when they complete the subscription
cancellation flow (cancellation reason survey).
read / write
- countryCode ↔ String
-
ISO 3166-1 alpha-2 billing country/region code of the user at the time the
subscription was granted.
read / write
- developerPayload ↔ String
-
A developer-specified string that contains supplemental information about
an order.
read / write
- emailAddress ↔ String
-
The email address of the user when the subscription was purchased. Only
present for purchases made with 'Subscribe with Google'.
read / write
- expiryTimeMillis ↔ String
-
Time at which the subscription will expire, in milliseconds since the
Epoch.
read / write
- externalAccountId ↔ String
-
User account identifier in the third-party service. Only present if
account linking happened as part of the subscription purchase flow.
read / write
- familyName ↔ String
-
The family name of the user when the subscription was purchased. Only
present for purchases made with 'Subscribe with Google'.
read / write
- givenName ↔ String
-
The given name of the user when the subscription was purchased. Only
present for purchases made with 'Subscribe with Google'.
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- introductoryPriceInfo ↔ IntroductoryPriceInfo
-
Introductory price information of the subscription. This is only present
when the subscription was purchased with an introductory price. This field
does not indicate the subscription is currently in introductory price
period.
read / write
- kind ↔ String
-
This kind represents a subscriptionPurchase object in the androidpublisher
service.
read / write
- linkedPurchaseToken ↔ String
-
The purchase token of the originating purchase if this subscription is one
of the following: 0. Re-signup of a canceled but non-lapsed subscription [...]
read / write
- obfuscatedExternalAccountId ↔ String
-
An obfuscated version of the id that is uniquely associated with the
user's account in your app. Present for the following purchases: * If
account linking happened as part of the subscription purchase flow. * It
was specified using
https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid
when the purchase was made.
read / write
- obfuscatedExternalProfileId ↔ String
-
An obfuscated version of the id that is uniquely associated with the
user's profile in your app. Only present if specified using
https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid
when the purchase was made.
read / write
- orderId ↔ String
-
The order id of the latest recurring order associated with the purchase of
the subscription.
read / write
- paymentState ↔ int
-
The payment state of the subscription. Possible values are: 0. Payment
pending 1. Payment received 2. Free trial 3. Pending deferred
upgrade/downgrade
read / write
- priceAmountMicros ↔ String
-
Price of the subscription, not including tax. Price is expressed in
micro-units, where 1,000,000 micro-units represents one unit of the
currency. For example, if the subscription price is €1.99,
price_amount_micros is 1990000.
read / write
- priceChange ↔ SubscriptionPriceChange
-
The latest price change information available. This is present only when
there is an upcoming price change for the subscription yet to be applied.
Once the subscription renews with the new price or the subscription is
canceled, no price change information will be returned.
read / write
- priceCurrencyCode ↔ String
-
ISO 4217 currency code for the subscription price. For example, if the
price is specified in British pounds sterling, price_currency_code is
"GBP".
read / write
- profileId ↔ String
-
The Google profile id of the user when the subscription was purchased.
Only present for purchases made with 'Subscribe with Google'.
read / write
- profileName ↔ String
-
The profile name of the user when the subscription was purchased. Only
present for purchases made with 'Subscribe with Google'.
read / write
- promotionCode ↔ String
-
The promotion code applied on this purchase. This field is only set if a
vanity code promotion is applied when the subscription was purchased.
read / write
- promotionType ↔ int
-
The type of promotion applied on this purchase. This field is only set if
a promotion is applied when the subscription was purchased. Possible
values are: 0. One time code 1. Vanity code
read / write
- purchaseType ↔ int
-
The type of purchase of the subscription. This field is only set if this
purchase was not made using the standard in-app billing flow. Possible
values are: 0. Test (i.e. purchased from a license testing account) 1.
Promo (i.e. purchased using a promo code)
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- startTimeMillis ↔ String
-
Time at which the subscription was granted, in milliseconds since the
Epoch.
read / write
- userCancellationTimeMillis ↔ String
-
The time at which the subscription was canceled by the user, in
milliseconds since the epoch. Only present if cancelReason is 0.
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, Object> -
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited