GoogleApi.AndroidPublisher.V3.Model.SubscriptionPurchase (google_api_android_publisher v0.28.0) 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: 0. Yet to be acknowledged 1. 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: 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
  • 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.
  • externalAccountId (type: String.t, default: nil) - User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow.
  • 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: nil) - 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: 0. Re-signup of a canceled but non-lapsed subscription 1. 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.
  • obfuscatedExternalAccountId (type: String.t, default: nil) - 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.
  • obfuscatedExternalProfileId (type: String.t, default: nil) - 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.
  • orderId (type: String.t, default: nil) - The order id of the latest recurring order associated with the purchase of the subscription. If the subscription was canceled because payment was declined, this will be the order id from the payment declined order.
  • paymentState (type: integer(), default: nil) - The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade Not present for canceled, expired subscriptions.
  • priceAmountMicros (type: String.t, default: nil) - Price of the subscription, For tax exclusive countries, the price doesn't include tax. For tax inclusive countries, the price includes 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'.
  • promotionCode (type: String.t, default: nil) - The promotion code applied on this purchase. This field is only set if a vanity code promotion is applied when the subscription was purchased.
  • promotionType (type: integer(), default: nil) - 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
  • 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: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code)
  • 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

Specs

t() :: %GoogleApi.AndroidPublisher.V3.Model.SubscriptionPurchase{
  acknowledgementState: integer() | nil,
  autoRenewing: boolean() | nil,
  autoResumeTimeMillis: String.t() | nil,
  cancelReason: integer() | nil,
  cancelSurveyResult:
    GoogleApi.AndroidPublisher.V3.Model.SubscriptionCancelSurveyResult.t() | nil,
  countryCode: String.t() | nil,
  developerPayload: String.t() | nil,
  emailAddress: String.t() | nil,
  expiryTimeMillis: String.t() | nil,
  externalAccountId: String.t() | nil,
  familyName: String.t() | nil,
  givenName: String.t() | nil,
  introductoryPriceInfo:
    GoogleApi.AndroidPublisher.V3.Model.IntroductoryPriceInfo.t() | nil,
  kind: String.t() | nil,
  linkedPurchaseToken: String.t() | nil,
  obfuscatedExternalAccountId: String.t() | nil,
  obfuscatedExternalProfileId: String.t() | nil,
  orderId: String.t() | nil,
  paymentState: integer() | nil,
  priceAmountMicros: String.t() | nil,
  priceChange:
    GoogleApi.AndroidPublisher.V3.Model.SubscriptionPriceChange.t() | nil,
  priceCurrencyCode: String.t() | nil,
  profileId: String.t() | nil,
  profileName: String.t() | nil,
  promotionCode: String.t() | nil,
  promotionType: integer() | nil,
  purchaseType: integer() | nil,
  startTimeMillis: String.t() | nil,
  userCancellationTimeMillis: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.