com.squareup.square.models

Class SubscriptionEvent

java.lang.Object

com.squareup.square.models.SubscriptionEvent

public class SubscriptionEvent
extends Object

This is a model class for SubscriptionEvent type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	SubscriptionEvent(String id, String subscriptionEventType, String effectiveDate, String planVariationId, Integer monthlyBillingAnchorDate, SubscriptionEventInfo info, List<Phase> phases) Initialization constructor.
protected	SubscriptionEvent(String id, String subscriptionEventType, String effectiveDate, String planVariationId, Integer monthlyBillingAnchorDate, SubscriptionEventInfo info, io.apimatic.core.types.OptionalNullable<List<Phase>> phases) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getEffectiveDate() Getter for EffectiveDate.
String	getId() Getter for Id.
SubscriptionEventInfo	getInfo() Getter for Info.
Integer	getMonthlyBillingAnchorDate() Getter for MonthlyBillingAnchorDate.
List<Phase>	getPhases() Getter for Phases.
String	getPlanVariationId() Getter for PlanVariationId.
String	getSubscriptionEventType() Getter for SubscriptionEventType.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<Phase>>	internalGetPhases() Internal Getter for Phases.
SubscriptionEvent.Builder	toBuilder() Builds a new SubscriptionEvent.Builder object.
String	toString() Converts this SubscriptionEvent into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionEvent

public SubscriptionEvent(String id,
                         String subscriptionEventType,
                         String effectiveDate,
                         String planVariationId,
                         Integer monthlyBillingAnchorDate,
                         SubscriptionEventInfo info,
                         List<Phase> phases)

Initialization constructor.

Parameters:

id - String value for id.

subscriptionEventType - String value for subscriptionEventType.

effectiveDate - String value for effectiveDate.

planVariationId - String value for planVariationId.

monthlyBillingAnchorDate - Integer value for monthlyBillingAnchorDate.

info - SubscriptionEventInfo value for info.

phases - List of Phase value for phases.

SubscriptionEvent

protected SubscriptionEvent(String id,
                            String subscriptionEventType,
                            String effectiveDate,
                            String planVariationId,
                            Integer monthlyBillingAnchorDate,
                            SubscriptionEventInfo info,
                            io.apimatic.core.types.OptionalNullable<List<Phase>> phases)

Initialization constructor.

Parameters:

id - String value for id.

subscriptionEventType - String value for subscriptionEventType.

effectiveDate - String value for effectiveDate.

planVariationId - String value for planVariationId.

monthlyBillingAnchorDate - Integer value for monthlyBillingAnchorDate.

info - SubscriptionEventInfo value for info.

phases - List of Phase value for phases.

Method Detail

getId

public String getId()

Getter for Id. The ID of the subscription event.

Returns:

Returns the String

getSubscriptionEventType

public String getSubscriptionEventType()

Getter for SubscriptionEventType. Supported types of an event occurred to a subscription.

Returns:

Returns the String

getEffectiveDate

public String getEffectiveDate()

Getter for EffectiveDate. The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when the subscription event occurred.

Returns:

Returns the String

getMonthlyBillingAnchorDate

public Integer getMonthlyBillingAnchorDate()

Getter for MonthlyBillingAnchorDate. The day-of-the-month the billing anchor date was changed to, if applicable.

Returns:

Returns the Integer

getInfo

public SubscriptionEventInfo getInfo()

Getter for Info. Provides information about the subscription event.

Returns:

Returns the SubscriptionEventInfo

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

getPlanVariationId

public String getPlanVariationId()

Getter for PlanVariationId. The ID of the subscription plan variation associated with the subscription.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SubscriptionEvent.Builder toBuilder()

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

Returns:

a new SubscriptionEvent.Builder object