com.squareup.square.models

Class SubscriptionAction

java.lang.Object

com.squareup.square.models.SubscriptionAction

public class SubscriptionAction
extends Object

This is a model class for SubscriptionAction type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubscriptionAction(String id, String type, io.apimatic.core.types.OptionalNullable<String> effectiveDate, io.apimatic.core.types.OptionalNullable<Integer> monthlyBillingAnchorDate, io.apimatic.core.types.OptionalNullable<List<Phase>> phases, io.apimatic.core.types.OptionalNullable<String> newPlanVariationId) Initialization constructor.
	SubscriptionAction(String id, String type, String effectiveDate, Integer monthlyBillingAnchorDate, List<Phase> phases, String newPlanVariationId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getEffectiveDate() Getter for EffectiveDate.
String	getId() Getter for Id.
Integer	getMonthlyBillingAnchorDate() Getter for MonthlyBillingAnchorDate.
String	getNewPlanVariationId() Getter for NewPlanVariationId.
List<Phase>	getPhases() Getter for Phases.
String	getType() Getter for Type.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetEffectiveDate() Internal Getter for EffectiveDate.
protected io.apimatic.core.types.OptionalNullable<Integer>	internalGetMonthlyBillingAnchorDate() Internal Getter for MonthlyBillingAnchorDate.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetNewPlanVariationId() Internal Getter for NewPlanVariationId.
protected io.apimatic.core.types.OptionalNullable<List<Phase>>	internalGetPhases() Internal Getter for Phases.
SubscriptionAction.Builder	toBuilder() Builds a new SubscriptionAction.Builder object.
String	toString() Converts this SubscriptionAction into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionAction

public SubscriptionAction(String id,
                          String type,
                          String effectiveDate,
                          Integer monthlyBillingAnchorDate,
                          List<Phase> phases,
                          String newPlanVariationId)

Initialization constructor.

Parameters:

id - String value for id.

type - String value for type.

effectiveDate - String value for effectiveDate.

monthlyBillingAnchorDate - Integer value for monthlyBillingAnchorDate.

phases - List of Phase value for phases.

newPlanVariationId - String value for newPlanVariationId.

SubscriptionAction

protected SubscriptionAction(String id,
                             String type,
                             io.apimatic.core.types.OptionalNullable<String> effectiveDate,
                             io.apimatic.core.types.OptionalNullable<Integer> monthlyBillingAnchorDate,
                             io.apimatic.core.types.OptionalNullable<List<Phase>> phases,
                             io.apimatic.core.types.OptionalNullable<String> newPlanVariationId)

Initialization constructor.

Parameters:

id - String value for id.

type - String value for type.

effectiveDate - String value for effectiveDate.

monthlyBillingAnchorDate - Integer value for monthlyBillingAnchorDate.

phases - List of Phase value for phases.

newPlanVariationId - String value for newPlanVariationId.

Method Detail

getId

public String getId()

Getter for Id. The ID of an action scoped to a subscription.

Returns:

Returns the String

getType

public String getType()

Getter for Type. Supported types of an action as a pending change to a subscription.

Returns:

Returns the String

internalGetEffectiveDate

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

Internal Getter for EffectiveDate. The `YYYY-MM-DD`-formatted date when the action occurs on the subscription.

Returns:

Returns the Internal String

getEffectiveDate

public String getEffectiveDate()

Getter for EffectiveDate. The `YYYY-MM-DD`-formatted date when the action occurs on the subscription.

Returns:

Returns the String

internalGetMonthlyBillingAnchorDate

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

Internal Getter for MonthlyBillingAnchorDate. The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action.

Returns:

Returns the Internal Integer

getMonthlyBillingAnchorDate

public Integer getMonthlyBillingAnchorDate()

Getter for MonthlyBillingAnchorDate. The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action.

Returns:

Returns the Integer

internalGetPhases

protected io.apimatic.core.types.OptionalNullable<List<Phase>> internalGetPhases()

Internal Getter for Phases. A list of Phases, to pass phase-specific information used in the swap.

Returns:

Returns the Internal List of Phase

getPhases

public List<Phase> getPhases()

Getter for Phases. A list of Phases, to pass phase-specific information used in the swap.

Returns:

Returns the List of Phase

internalGetNewPlanVariationId

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

Internal Getter for NewPlanVariationId. The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action.

Returns:

Returns the Internal String

getNewPlanVariationId

public String getNewPlanVariationId()

Getter for NewPlanVariationId. The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action.

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 SubscriptionAction into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SubscriptionAction.Builder toBuilder()

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

Returns:

a new SubscriptionAction.Builder object