com.squareup.square.models

Class SubscriptionPhase

java.lang.Object

com.squareup.square.models.SubscriptionPhase

public class SubscriptionPhase
extends Object

This is a model class for SubscriptionPhase type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SubscriptionPhase(String cadence, Money recurringPriceMoney, String uid, Integer periods, Long ordinal) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCadence() Getter for Cadence.
Long	getOrdinal() Getter for Ordinal.
Integer	getPeriods() Getter for Periods.
Money	getRecurringPriceMoney() Getter for RecurringPriceMoney.
String	getUid() Getter for Uid.
int	hashCode()
SubscriptionPhase.Builder	toBuilder() Builds a new SubscriptionPhase.Builder object.
String	toString() Converts this SubscriptionPhase into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionPhase

public SubscriptionPhase(String cadence,
                         Money recurringPriceMoney,
                         String uid,
                         Integer periods,
                         Long ordinal)

Initialization constructor.

Parameters:

cadence - String value for cadence.

recurringPriceMoney - Money value for recurringPriceMoney.

uid - String value for uid.

periods - Integer value for periods.

ordinal - Long value for ordinal.

Method Detail

getUid

public String getUid()

Getter for Uid. The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.

Returns:

Returns the String

getCadence

public String getCadence()

Getter for Cadence. Determines the billing cadence of a [Subscription]($m/Subscription)

Returns:

Returns the String

getPeriods

public Integer getPeriods()

Getter for Periods. The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.

Returns:

Returns the Integer

getRecurringPriceMoney

public Money getRecurringPriceMoney()

Getter for RecurringPriceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.

Returns:

Returns the Money

getOrdinal

public Long getOrdinal()

Getter for Ordinal. The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.

Returns:

Returns the Long

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SubscriptionPhase.Builder toBuilder()

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

Returns:

a new SubscriptionPhase.Builder object