com.google.api.services.androidpublisher.model

Class AutoRenewingBasePlanType

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.AutoRenewingBasePlanType

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AutoRenewingBasePlanType
extends com.google.api.client.json.GenericJson

Represents a base plan that automatically renews at the end of its subscription period.

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 Android Developer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

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

com.google.api.client.util.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
AutoRenewingBasePlanType()

Method Summary

Modifier and Type	Method and Description
AutoRenewingBasePlanType	clone()
String	getAccountHoldDuration() Optional.
String	getBillingPeriodDuration() Required.
String	getGracePeriodDuration() Grace period of the subscription, specified in ISO 8601 format.
Boolean	getLegacyCompatible() Whether the renewing base plan is backward compatible.
String	getLegacyCompatibleSubscriptionOfferId() Subscription offer id which is legacy compatible.
String	getProrationMode() The proration mode for the base plan determines what happens when a user switches to this plan from another base plan.
String	getResubscribeState() Whether users should be able to resubscribe to this base plan in Google Play surfaces.
AutoRenewingBasePlanType	set(String fieldName, Object value)
AutoRenewingBasePlanType	setAccountHoldDuration(String accountHoldDuration) Optional.
AutoRenewingBasePlanType	setBillingPeriodDuration(String billingPeriodDuration) Required.
AutoRenewingBasePlanType	setGracePeriodDuration(String gracePeriodDuration) Grace period of the subscription, specified in ISO 8601 format.
AutoRenewingBasePlanType	setLegacyCompatible(Boolean legacyCompatible) Whether the renewing base plan is backward compatible.
AutoRenewingBasePlanType	setLegacyCompatibleSubscriptionOfferId(String legacyCompatibleSubscriptionOfferId) Subscription offer id which is legacy compatible.
AutoRenewingBasePlanType	setProrationMode(String prorationMode) The proration mode for the base plan determines what happens when a user switches to this plan from another base plan.
AutoRenewingBasePlanType	setResubscribeState(String resubscribeState) Whether users should be able to resubscribe to this base plan in Google Play surfaces.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

AutoRenewingBasePlanType

public AutoRenewingBasePlanType()

Method Detail

getAccountHoldDuration

public String getAccountHoldDuration()

Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).

Returns:

value or null for none

setAccountHoldDuration

public AutoRenewingBasePlanType setAccountHoldDuration(String accountHoldDuration)

Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).

Parameters:

accountHoldDuration - accountHoldDuration or null for none

getBillingPeriodDuration

public String getBillingPeriodDuration()

Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.

Returns:

value or null for none

setBillingPeriodDuration

public AutoRenewingBasePlanType setBillingPeriodDuration(String billingPeriodDuration)

Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.

Parameters:

billingPeriodDuration - billingPeriodDuration or null for none

getGracePeriodDuration

public String getGracePeriodDuration()

Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.

Returns:

value or null for none

setGracePeriodDuration

public AutoRenewingBasePlanType setGracePeriodDuration(String gracePeriodDuration)

Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.

Parameters:

gracePeriodDuration - gracePeriodDuration or null for none

getLegacyCompatible

public Boolean getLegacyCompatible()

Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.

Returns:

value or null for none

setLegacyCompatible

public AutoRenewingBasePlanType setLegacyCompatible(Boolean legacyCompatible)

Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.

Parameters:

legacyCompatible - legacyCompatible or null for none

getLegacyCompatibleSubscriptionOfferId

public String getLegacyCompatibleSubscriptionOfferId()

Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.

Returns:

value or null for none

setLegacyCompatibleSubscriptionOfferId

public AutoRenewingBasePlanType setLegacyCompatibleSubscriptionOfferId(String legacyCompatibleSubscriptionOfferId)

Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.

Parameters:

legacyCompatibleSubscriptionOfferId - legacyCompatibleSubscriptionOfferId or null for none

getProrationMode

public String getProrationMode()

The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.

Returns:

value or null for none

setProrationMode

public AutoRenewingBasePlanType setProrationMode(String prorationMode)

The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.

Parameters:

prorationMode - prorationMode or null for none

getResubscribeState

public String getResubscribeState()

Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.

Returns:

value or null for none

setResubscribeState

public AutoRenewingBasePlanType setResubscribeState(String resubscribeState)

Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.

Parameters:

resubscribeState - resubscribeState or null for none

set

public AutoRenewingBasePlanType set(String fieldName,
                                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AutoRenewingBasePlanType clone()

Overrides:

clone in class com.google.api.client.json.GenericJson