com.squareup.square.models

Class PauseSubscriptionRequest

java.lang.Object

com.squareup.square.models.PauseSubscriptionRequest

public class PauseSubscriptionRequest
extends Object

This is a model class for PauseSubscriptionRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PauseSubscriptionRequest(String pauseEffectiveDate, Long pauseCycleDuration, String resumeEffectiveDate, String resumeChangeTiming, String pauseReason) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getPauseCycleDuration() Getter for PauseCycleDuration.
String	getPauseEffectiveDate() Getter for PauseEffectiveDate.
String	getPauseReason() Getter for PauseReason.
String	getResumeChangeTiming() Getter for ResumeChangeTiming.
String	getResumeEffectiveDate() Getter for ResumeEffectiveDate.
int	hashCode()
PauseSubscriptionRequest.Builder	toBuilder() Builds a new PauseSubscriptionRequest.Builder object.
String	toString() Converts this PauseSubscriptionRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PauseSubscriptionRequest

public PauseSubscriptionRequest(String pauseEffectiveDate,
                                Long pauseCycleDuration,
                                String resumeEffectiveDate,
                                String resumeChangeTiming,
                                String pauseReason)

Initialization constructor.

Parameters:

pauseEffectiveDate - String value for pauseEffectiveDate.

pauseCycleDuration - Long value for pauseCycleDuration.

resumeEffectiveDate - String value for resumeEffectiveDate.

resumeChangeTiming - String value for resumeChangeTiming.

pauseReason - String value for pauseReason.

Method Detail

getPauseEffectiveDate

public String getPauseEffectiveDate()

Getter for PauseEffectiveDate. The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription. When this date is unspecified or falls within the current billing cycle, the subscription is paused on the starting date of the next billing cycle.

Returns:

Returns the String

getPauseCycleDuration

public Long getPauseCycleDuration()

Getter for PauseCycleDuration. The number of billing cycles the subscription will be paused before it is reactivated. When this is set, a `RESUME` action is also scheduled to take place on the subscription at the end of the specified pause cycle duration. In this case, neither `resume_effective_date` nor `resume_change_timing` may be specified.

Returns:

Returns the Long

getResumeEffectiveDate

public String getResumeEffectiveDate()

Getter for ResumeEffectiveDate. The date when the subscription is reactivated by a scheduled `RESUME` action. This date must be at least one billing cycle ahead of `pause_effective_date`.

Returns:

Returns the String

getResumeChangeTiming

public String getResumeChangeTiming()

Getter for ResumeChangeTiming. Supported timings when a pending change, as an action, takes place to a subscription.

Returns:

Returns the String

getPauseReason

public String getPauseReason()

Getter for PauseReason. The user-provided reason to pause 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 PauseSubscriptionRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PauseSubscriptionRequest.Builder toBuilder()

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

Returns:

a new PauseSubscriptionRequest.Builder object