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

Constructor and Description
SubscriptionAction(String id, String type, String effectiveDate, String newPlanId) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getEffectiveDate() Getter for EffectiveDate.
String	getId() Getter for Id.
String	getNewPlanId() Getter for NewPlanId.
String	getType() Getter for Type.
int	hashCode()
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,
                          String newPlanId)

Initialization constructor.

Parameters:

id - String value for id.

type - String value for type.

effectiveDate - String value for effectiveDate.

newPlanId - String value for newPlanId.

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

getEffectiveDate

public String getEffectiveDate()

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

Returns:

Returns the String

getNewPlanId

public String getNewPlanId()

Getter for NewPlanId. The target subscription plan 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