google_api_android_publisher v0.7.0 GoogleApi.AndroidPublisher.V3.Model.SubscriptionPurchase View Source
A SubscriptionPurchase resource indicates the status of a user's subscription purchase.
Attributes
acknowledgementState
(type:integer()
, default:nil
) - The acknowledgement state of the subscription product. Possible values are:- Yet to be acknowledged
- Acknowledged
autoRenewing
(type:boolean()
, default:nil
) - Whether the subscription will automatically be renewed when it reaches its current expiry time.autoResumeTimeMillis
(type:String.t
, default:nil
) - 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.cancelReason
(type:integer()
, default:nil
) - The reason why a subscription was canceled or is not auto-renewing. Possible values are:- User canceled the subscription
- Subscription was canceled by the system, for example because of a billing problem
- Subscription was replaced with a new subscription
- Subscription was canceled by the developer
cancelSurveyResult
(type:GoogleApi.AndroidPublisher.V3.Model.SubscriptionCancelSurveyResult.t
, default:nil
) - Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).countryCode
(type:String.t
, default:nil
) - ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.developerPayload
(type:String.t
, default:nil
) - A developer-specified string that contains supplemental information about an order.emailAddress
(type:String.t
, default:nil
) - The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.expiryTimeMillis
(type:String.t
, default:nil
) - Time at which the subscription will expire, in milliseconds since the Epoch.familyName
(type:String.t
, default:nil
) - The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.givenName
(type:String.t
, default:nil
) - The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.introductoryPriceInfo
(type:GoogleApi.AndroidPublisher.V3.Model.IntroductoryPriceInfo.t
, default:nil
) - 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.
kind
(type:String.t
, default:androidpublisher#subscriptionPurchase
) - This kind represents a subscriptionPurchase object in the androidpublisher service.linkedPurchaseToken
(type:String.t
, default:nil
) - The purchase token of the originating purchase if this subscription is one of the following:- Re-signup of a canceled but non-lapsed subscription
- Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.
orderId
(type:String.t
, default:nil
) - The order id of the latest recurring order associated with the purchase of the subscription.paymentState
(type:integer()
, default:nil
) - The payment state of the subscription. Possible values are:- Payment pending
- Payment received
- Free trial
- Pending deferred upgrade/downgrade
priceAmountMicros
(type:String.t
, default:nil
) - 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.priceChange
(type:GoogleApi.AndroidPublisher.V3.Model.SubscriptionPriceChange.t
, default:nil
) - 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.
priceCurrencyCode
(type:String.t
, default:nil
) - ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".profileId
(type:String.t
, default:nil
) - The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.profileName
(type:String.t
, default:nil
) - The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.purchaseType
(type:integer()
, default:nil
) - 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:- Test (i.e. purchased from a license testing account)
startTimeMillis
(type:String.t
, default:nil
) - Time at which the subscription was granted, in milliseconds since the Epoch.userCancellationTimeMillis
(type:String.t
, default:nil
) - The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Sourcet() :: %GoogleApi.AndroidPublisher.V3.Model.SubscriptionPurchase{ acknowledgementState: integer(), autoRenewing: boolean(), autoResumeTimeMillis: String.t(), cancelReason: integer(), cancelSurveyResult: GoogleApi.AndroidPublisher.V3.Model.SubscriptionCancelSurveyResult.t(), countryCode: String.t(), developerPayload: String.t(), emailAddress: String.t(), expiryTimeMillis: String.t(), familyName: String.t(), givenName: String.t(), introductoryPriceInfo: GoogleApi.AndroidPublisher.V3.Model.IntroductoryPriceInfo.t(), kind: String.t(), linkedPurchaseToken: String.t(), orderId: String.t(), paymentState: integer(), priceAmountMicros: String.t(), priceChange: GoogleApi.AndroidPublisher.V3.Model.SubscriptionPriceChange.t(), priceCurrencyCode: String.t(), profileId: String.t(), profileName: String.t(), purchaseType: integer(), startTimeMillis: String.t(), userCancellationTimeMillis: String.t() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.