com.google.api.services.androidpublisher.model

Class InstallmentsBasePlanType

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Represents an installments base plan where a user commits to a specified number of payments.

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
InstallmentsBasePlanType()

Method Summary

Modifier and Type	Method and Description
InstallmentsBasePlanType	clone()
String	getAccountHoldDuration() Optional.
String	getBillingPeriodDuration() Required.
Integer	getCommittedPaymentsCount() Required.
String	getGracePeriodDuration() Grace period of the subscription, specified in ISO 8601 format.
String	getProrationMode() The proration mode for the base plan determines what happens when a user switches to this plan from another base plan.
String	getRenewalType() Required.
String	getResubscribeState() Whether users should be able to resubscribe to this base plan in Google Play surfaces.
InstallmentsBasePlanType	set(String fieldName, Object value)
InstallmentsBasePlanType	setAccountHoldDuration(String accountHoldDuration) Optional.
InstallmentsBasePlanType	setBillingPeriodDuration(String billingPeriodDuration) Required.
InstallmentsBasePlanType	setCommittedPaymentsCount(Integer committedPaymentsCount) Required.
InstallmentsBasePlanType	setGracePeriodDuration(String gracePeriodDuration) Grace period of the subscription, specified in ISO 8601 format.
InstallmentsBasePlanType	setProrationMode(String prorationMode) The proration mode for the base plan determines what happens when a user switches to this plan from another base plan.
InstallmentsBasePlanType	setRenewalType(String renewalType) Required.
InstallmentsBasePlanType	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

InstallmentsBasePlanType

public InstallmentsBasePlanType()

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 between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.

Returns:

value or null for none

setAccountHoldDuration

public InstallmentsBasePlanType setAccountHoldDuration(String accountHoldDuration)

Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.

Parameters:

accountHoldDuration - accountHoldDuration or null for none

getBillingPeriodDuration

public String getBillingPeriodDuration()

Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.

Returns:

value or null for none

setBillingPeriodDuration

public InstallmentsBasePlanType setBillingPeriodDuration(String billingPeriodDuration)

Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.

Parameters:

billingPeriodDuration - billingPeriodDuration or null for none

getCommittedPaymentsCount

public Integer getCommittedPaymentsCount()

Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.

Returns:

value or null for none

setCommittedPaymentsCount

public InstallmentsBasePlanType setCommittedPaymentsCount(Integer committedPaymentsCount)

Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.

Parameters:

committedPaymentsCount - committedPaymentsCount or null for none

getGracePeriodDuration

public String getGracePeriodDuration()

Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.

Returns:

value or null for none

setGracePeriodDuration

public InstallmentsBasePlanType setGracePeriodDuration(String gracePeriodDuration)

Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.

Parameters:

gracePeriodDuration - gracePeriodDuration 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 InstallmentsBasePlanType 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

getRenewalType

public String getRenewalType()

Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.

Returns:

value or null for none

setRenewalType

public InstallmentsBasePlanType setRenewalType(String renewalType)

Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.

Parameters:

renewalType - renewalType 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 InstallmentsBasePlanType 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 InstallmentsBasePlanType set(String fieldName,
                                    Object value)

Overrides:

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

clone

public InstallmentsBasePlanType clone()

Overrides:

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