com.squareup.square.models

Class CatalogSubscriptionPlanVariation

java.lang.Object

com.squareup.square.models.CatalogSubscriptionPlanVariation

public class CatalogSubscriptionPlanVariation
extends Object

This is a model class for CatalogSubscriptionPlanVariation type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogSubscriptionPlanVariation.Builder Class to build instances of CatalogSubscriptionPlanVariation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CatalogSubscriptionPlanVariation(String name, List<SubscriptionPhase> phases, io.apimatic.core.types.OptionalNullable<String> subscriptionPlanId, io.apimatic.core.types.OptionalNullable<Long> monthlyBillingAnchorDate, io.apimatic.core.types.OptionalNullable<Boolean> canProrate, io.apimatic.core.types.OptionalNullable<String> successorPlanVariationId) Initialization constructor.
	CatalogSubscriptionPlanVariation(String name, List<SubscriptionPhase> phases, String subscriptionPlanId, Long monthlyBillingAnchorDate, Boolean canProrate, String successorPlanVariationId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getCanProrate() Getter for CanProrate.
Long	getMonthlyBillingAnchorDate() Getter for MonthlyBillingAnchorDate.
String	getName() Getter for Name.
List<SubscriptionPhase>	getPhases() Getter for Phases.
String	getSubscriptionPlanId() Getter for SubscriptionPlanId.
String	getSuccessorPlanVariationId() Getter for SuccessorPlanVariationId.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetCanProrate() Internal Getter for CanProrate.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetMonthlyBillingAnchorDate() Internal Getter for MonthlyBillingAnchorDate.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSubscriptionPlanId() Internal Getter for SubscriptionPlanId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSuccessorPlanVariationId() Internal Getter for SuccessorPlanVariationId.
CatalogSubscriptionPlanVariation.Builder	toBuilder() Builds a new CatalogSubscriptionPlanVariation.Builder object.
String	toString() Converts this CatalogSubscriptionPlanVariation into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogSubscriptionPlanVariation

public CatalogSubscriptionPlanVariation(String name,
                                        List<SubscriptionPhase> phases,
                                        String subscriptionPlanId,
                                        Long monthlyBillingAnchorDate,
                                        Boolean canProrate,
                                        String successorPlanVariationId)

Initialization constructor.

Parameters:

name - String value for name.

phases - List of SubscriptionPhase value for phases.

subscriptionPlanId - String value for subscriptionPlanId.

monthlyBillingAnchorDate - Long value for monthlyBillingAnchorDate.

canProrate - Boolean value for canProrate.

successorPlanVariationId - String value for successorPlanVariationId.

CatalogSubscriptionPlanVariation

protected CatalogSubscriptionPlanVariation(String name,
                                           List<SubscriptionPhase> phases,
                                           io.apimatic.core.types.OptionalNullable<String> subscriptionPlanId,
                                           io.apimatic.core.types.OptionalNullable<Long> monthlyBillingAnchorDate,
                                           io.apimatic.core.types.OptionalNullable<Boolean> canProrate,
                                           io.apimatic.core.types.OptionalNullable<String> successorPlanVariationId)

Initialization constructor.

Parameters:

name - String value for name.

phases - List of SubscriptionPhase value for phases.

subscriptionPlanId - String value for subscriptionPlanId.

monthlyBillingAnchorDate - Long value for monthlyBillingAnchorDate.

canProrate - Boolean value for canProrate.

successorPlanVariationId - String value for successorPlanVariationId.

Method Detail

getName

public String getName()

Getter for Name. The name of the plan variation.

Returns:

Returns the String

getPhases

public List<SubscriptionPhase> getPhases()

Getter for Phases. A list containing each [SubscriptionPhase](entity:SubscriptionPhase) for this plan variation.

Returns:

Returns the List of SubscriptionPhase

internalGetSubscriptionPlanId

protected io.apimatic.core.types.OptionalNullable<String> internalGetSubscriptionPlanId()

Internal Getter for SubscriptionPlanId. The id of the subscription plan, if there is one.

Returns:

Returns the Internal String

getSubscriptionPlanId

public String getSubscriptionPlanId()

Getter for SubscriptionPlanId. The id of the subscription plan, if there is one.

Returns:

Returns the String

internalGetMonthlyBillingAnchorDate

protected io.apimatic.core.types.OptionalNullable<Long> internalGetMonthlyBillingAnchorDate()

Internal Getter for MonthlyBillingAnchorDate. The day of the month the billing period starts.

Returns:

Returns the Internal Long

getMonthlyBillingAnchorDate

public Long getMonthlyBillingAnchorDate()

Getter for MonthlyBillingAnchorDate. The day of the month the billing period starts.

Returns:

Returns the Long

internalGetCanProrate

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetCanProrate()

Internal Getter for CanProrate. Whether bills for this plan variation can be split for proration.

Returns:

Returns the Internal Boolean

getCanProrate

public Boolean getCanProrate()

Getter for CanProrate. Whether bills for this plan variation can be split for proration.

Returns:

Returns the Boolean

internalGetSuccessorPlanVariationId

protected io.apimatic.core.types.OptionalNullable<String> internalGetSuccessorPlanVariationId()

Internal Getter for SuccessorPlanVariationId. The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all locations, it indicates that this variation is deprecated and the object identified by the successor ID be used in its stead.

Returns:

Returns the Internal String

getSuccessorPlanVariationId

public String getSuccessorPlanVariationId()

Getter for SuccessorPlanVariationId. The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all locations, it indicates that this variation is deprecated and the object identified by the successor ID be used in its stead.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CatalogSubscriptionPlanVariation into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CatalogSubscriptionPlanVariation.Builder toBuilder()

Builds a new CatalogSubscriptionPlanVariation.Builder object. Creates the instance with the state of the current model.

Returns:

a new CatalogSubscriptionPlanVariation.Builder object