com.google.api.services.androidpublisher.model

Class SubscriptionPurchase

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.androidpublisher.model.SubscriptionPurchase

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SubscriptionPurchase
extends GenericJson

A SubscriptionPurchase resource indicates the status of a user's subscription purchase.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Developer API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SubscriptionPurchase()

Method Summary

Modifier and Type	Method and Description
SubscriptionPurchase	clone()
Boolean	getAutoRenewing() Whether the subscription will automatically be renewed when it reaches its current expiry time.
Long	getAutoResumeTimeMillis() Time at which the subscription will be automatically resumed, in milliseconds since the Epoch.
Integer	getCancelReason() The reason why a subscription was canceled or is not auto-renewing.
SubscriptionCancelSurveyResult	getCancelSurveyResult() Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).
String	getCountryCode() ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
String	getDeveloperPayload() A developer-specified string that contains supplemental information about an order.
String	getEmailAddress() The email address of the user when the subscription was purchased.
Long	getExpiryTimeMillis() Time at which the subscription will expire, in milliseconds since the Epoch.
String	getFamilyName() The family name of the user when the subscription was purchased.
String	getGivenName() The given name of the user when the subscription was purchased.
String	getKind() This kind represents a subscriptionPurchase object in the androidpublisher service.
String	getLinkedPurchaseToken() 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.
String	getOrderId() The order id of the latest recurring order associated with the purchase of the subscription.
Integer	getPaymentState() The payment state of the subscription.
Long	getPriceAmountMicros() Price of the subscription, not including tax.
SubscriptionPriceChange	getPriceChange() The latest price change information available.
String	getPriceCurrencyCode() ISO 4217 currency code for the subscription price.
String	getProfileId() The profile id of the user when the subscription was purchased.
String	getProfileName() The profile name of the user when the subscription was purchased.
Integer	getPurchaseType() The type of purchase of the subscription.
Long	getStartTimeMillis() Time at which the subscription was granted, in milliseconds since the Epoch.
Long	getUserCancellationTimeMillis() The time at which the subscription was canceled by the user, in milliseconds since the epoch.
SubscriptionPurchase	set(String fieldName, Object value)
SubscriptionPurchase	setAutoRenewing(Boolean autoRenewing) Whether the subscription will automatically be renewed when it reaches its current expiry time.
SubscriptionPurchase	setAutoResumeTimeMillis(Long autoResumeTimeMillis) Time at which the subscription will be automatically resumed, in milliseconds since the Epoch.
SubscriptionPurchase	setCancelReason(Integer cancelReason) The reason why a subscription was canceled or is not auto-renewing.
SubscriptionPurchase	setCancelSurveyResult(SubscriptionCancelSurveyResult cancelSurveyResult) Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).
SubscriptionPurchase	setCountryCode(String countryCode) ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.
SubscriptionPurchase	setDeveloperPayload(String developerPayload) A developer-specified string that contains supplemental information about an order.
SubscriptionPurchase	setEmailAddress(String emailAddress) The email address of the user when the subscription was purchased.
SubscriptionPurchase	setExpiryTimeMillis(Long expiryTimeMillis) Time at which the subscription will expire, in milliseconds since the Epoch.
SubscriptionPurchase	setFamilyName(String familyName) The family name of the user when the subscription was purchased.
SubscriptionPurchase	setGivenName(String givenName) The given name of the user when the subscription was purchased.
SubscriptionPurchase	setKind(String kind) This kind represents a subscriptionPurchase object in the androidpublisher service.
SubscriptionPurchase	setLinkedPurchaseToken(String linkedPurchaseToken) 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.
SubscriptionPurchase	setOrderId(String orderId) The order id of the latest recurring order associated with the purchase of the subscription.
SubscriptionPurchase	setPaymentState(Integer paymentState) The payment state of the subscription.
SubscriptionPurchase	setPriceAmountMicros(Long priceAmountMicros) Price of the subscription, not including tax.
SubscriptionPurchase	setPriceChange(SubscriptionPriceChange priceChange) The latest price change information available.
SubscriptionPurchase	setPriceCurrencyCode(String priceCurrencyCode) ISO 4217 currency code for the subscription price.
SubscriptionPurchase	setProfileId(String profileId) The profile id of the user when the subscription was purchased.
SubscriptionPurchase	setProfileName(String profileName) The profile name of the user when the subscription was purchased.
SubscriptionPurchase	setPurchaseType(Integer purchaseType) The type of purchase of the subscription.
SubscriptionPurchase	setStartTimeMillis(Long startTimeMillis) Time at which the subscription was granted, in milliseconds since the Epoch.
SubscriptionPurchase	setUserCancellationTimeMillis(Long userCancellationTimeMillis) The time at which the subscription was canceled by the user, in milliseconds since the epoch.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SubscriptionPurchase

public SubscriptionPurchase()

Method Detail

getAutoRenewing

public Boolean getAutoRenewing()

Whether the subscription will automatically be renewed when it reaches its current expiry time.

Returns:

value or null for none

setAutoRenewing

public SubscriptionPurchase setAutoRenewing(Boolean autoRenewing)

Whether the subscription will automatically be renewed when it reaches its current expiry time.

Parameters:

autoRenewing - autoRenewing or null for none

getAutoResumeTimeMillis

public Long getAutoResumeTimeMillis()

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.

Returns:

value or null for none

setAutoResumeTimeMillis

public SubscriptionPurchase setAutoResumeTimeMillis(Long autoResumeTimeMillis)

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.

Parameters:

autoResumeTimeMillis - autoResumeTimeMillis or null for none

getCancelReason

public Integer getCancelReason()

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

Returns:

value or null for none

setCancelReason

public SubscriptionPurchase setCancelReason(Integer cancelReason)

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

Parameters:

cancelReason - cancelReason or null for none

getCancelSurveyResult

public SubscriptionCancelSurveyResult getCancelSurveyResult()

Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).

Returns:

value or null for none

setCancelSurveyResult

public SubscriptionPurchase setCancelSurveyResult(SubscriptionCancelSurveyResult cancelSurveyResult)

Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).

Parameters:

cancelSurveyResult - cancelSurveyResult or null for none

getCountryCode

public String getCountryCode()

ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.

Returns:

value or null for none

setCountryCode

public SubscriptionPurchase setCountryCode(String countryCode)

ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted.

Parameters:

countryCode - countryCode or null for none

getDeveloperPayload

public String getDeveloperPayload()

A developer-specified string that contains supplemental information about an order.

Returns:

value or null for none

setDeveloperPayload

public SubscriptionPurchase setDeveloperPayload(String developerPayload)

A developer-specified string that contains supplemental information about an order.

Parameters:

developerPayload - developerPayload or null for none

getEmailAddress

public String getEmailAddress()

The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Returns:

value or null for none

setEmailAddress

public SubscriptionPurchase setEmailAddress(String emailAddress)

The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Parameters:

emailAddress - emailAddress or null for none

getExpiryTimeMillis

public Long getExpiryTimeMillis()

Time at which the subscription will expire, in milliseconds since the Epoch.

Returns:

value or null for none

setExpiryTimeMillis

public SubscriptionPurchase setExpiryTimeMillis(Long expiryTimeMillis)

Time at which the subscription will expire, in milliseconds since the Epoch.

Parameters:

expiryTimeMillis - expiryTimeMillis or null for none

getFamilyName

public String getFamilyName()

The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Returns:

value or null for none

setFamilyName

public SubscriptionPurchase setFamilyName(String familyName)

The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Parameters:

familyName - familyName or null for none

getGivenName

public String getGivenName()

The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Returns:

value or null for none

setGivenName

public SubscriptionPurchase setGivenName(String givenName)

The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Parameters:

givenName - givenName or null for none

getKind

public String getKind()

This kind represents a subscriptionPurchase object in the androidpublisher service.

Returns:

value or null for none

setKind

public SubscriptionPurchase setKind(String kind)

This kind represents a subscriptionPurchase object in the androidpublisher service.

Parameters:

kind - kind or null for none

getLinkedPurchaseToken

public String getLinkedPurchaseToken()

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.

Returns:

value or null for none

setLinkedPurchaseToken

public SubscriptionPurchase setLinkedPurchaseToken(String linkedPurchaseToken)

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.

Parameters:

linkedPurchaseToken - linkedPurchaseToken or null for none

getOrderId

public String getOrderId()

The order id of the latest recurring order associated with the purchase of the subscription.

Returns:

value or null for none

setOrderId

public SubscriptionPurchase setOrderId(String orderId)

The order id of the latest recurring order associated with the purchase of the subscription.

Parameters:

orderId - orderId or null for none

getPaymentState

public Integer getPaymentState()

The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade

Returns:

value or null for none

setPaymentState

public SubscriptionPurchase setPaymentState(Integer paymentState)

The payment state of the subscription. Possible values are: - Payment pending - Payment received - Free trial - Pending deferred upgrade/downgrade

Parameters:

paymentState - paymentState or null for none

getPriceAmountMicros

public Long getPriceAmountMicros()

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.

Returns:

value or null for none

setPriceAmountMicros

public SubscriptionPurchase setPriceAmountMicros(Long priceAmountMicros)

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.

Parameters:

priceAmountMicros - priceAmountMicros or null for none

getPriceChange

public SubscriptionPriceChange getPriceChange()

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.

Returns:

value or null for none

setPriceChange

public SubscriptionPurchase setPriceChange(SubscriptionPriceChange priceChange)

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.

Parameters:

priceChange - priceChange or null for none

getPriceCurrencyCode

public String getPriceCurrencyCode()

ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".

Returns:

value or null for none

setPriceCurrencyCode

public SubscriptionPurchase setPriceCurrencyCode(String priceCurrencyCode)

ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP".

Parameters:

priceCurrencyCode - priceCurrencyCode or null for none

getProfileId

public String getProfileId()

The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Returns:

value or null for none

setProfileId

public SubscriptionPurchase setProfileId(String profileId)

The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Parameters:

profileId - profileId or null for none

getProfileName

public String getProfileName()

The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Returns:

value or null for none

setProfileName

public SubscriptionPurchase setProfileName(String profileName)

The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.

Parameters:

profileName - profileName or null for none

getPurchaseType

public Integer getPurchaseType()

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)

Returns:

value or null for none

setPurchaseType

public SubscriptionPurchase setPurchaseType(Integer purchaseType)

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)

Parameters:

purchaseType - purchaseType or null for none

getStartTimeMillis

public Long getStartTimeMillis()

Time at which the subscription was granted, in milliseconds since the Epoch.

Returns:

value or null for none

setStartTimeMillis

public SubscriptionPurchase setStartTimeMillis(Long startTimeMillis)

Time at which the subscription was granted, in milliseconds since the Epoch.

Parameters:

startTimeMillis - startTimeMillis or null for none

getUserCancellationTimeMillis

public Long getUserCancellationTimeMillis()

The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.

Returns:

value or null for none

setUserCancellationTimeMillis

public SubscriptionPurchase setUserCancellationTimeMillis(Long userCancellationTimeMillis)

The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0.

Parameters:

userCancellationTimeMillis - userCancellationTimeMillis or null for none

set

public SubscriptionPurchase set(String fieldName,
                                Object value)

Overrides:

set in class GenericJson

clone

public SubscriptionPurchase clone()

Overrides:

clone in class GenericJson