com.paypal.sdk.models

Class SubscriptionBillingInformation

java.lang.Object

com.paypal.sdk.models.SubscriptionBillingInformation

public class SubscriptionBillingInformation
extends Object

This is a model class for SubscriptionBillingInformation type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SubscriptionBillingInformation() Default constructor.
SubscriptionBillingInformation(Money outstandingBalance, int failedPaymentsCount, List<CycleExecution> cycleExecutions, LastPaymentDetails lastPayment, String nextBillingTime, String finalPaymentTime, FailedPaymentDetails lastFailedPayment) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
List<CycleExecution>	getCycleExecutions() Getter for CycleExecutions.
int	getFailedPaymentsCount() Getter for FailedPaymentsCount.
String	getFinalPaymentTime() Getter for FinalPaymentTime.
FailedPaymentDetails	getLastFailedPayment() Getter for LastFailedPayment.
LastPaymentDetails	getLastPayment() Getter for LastPayment.
String	getNextBillingTime() Getter for NextBillingTime.
Money	getOutstandingBalance() Getter for OutstandingBalance.
void	setCycleExecutions(List<CycleExecution> cycleExecutions) Setter for CycleExecutions.
void	setFailedPaymentsCount(int failedPaymentsCount) Setter for FailedPaymentsCount.
void	setFinalPaymentTime(String finalPaymentTime) Setter for FinalPaymentTime.
void	setLastFailedPayment(FailedPaymentDetails lastFailedPayment) Setter for LastFailedPayment.
void	setLastPayment(LastPaymentDetails lastPayment) Setter for LastPayment.
void	setNextBillingTime(String nextBillingTime) Setter for NextBillingTime.
void	setOutstandingBalance(Money outstandingBalance) Setter for OutstandingBalance.
SubscriptionBillingInformation.Builder	toBuilder() Builds a new SubscriptionBillingInformation.Builder object.
String	toString() Converts this SubscriptionBillingInformation into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscriptionBillingInformation

public SubscriptionBillingInformation()

Default constructor.

SubscriptionBillingInformation

public SubscriptionBillingInformation(Money outstandingBalance,
                                      int failedPaymentsCount,
                                      List<CycleExecution> cycleExecutions,
                                      LastPaymentDetails lastPayment,
                                      String nextBillingTime,
                                      String finalPaymentTime,
                                      FailedPaymentDetails lastFailedPayment)

Initialization constructor.

Parameters:

outstandingBalance - Money value for outstandingBalance.

failedPaymentsCount - int value for failedPaymentsCount.

cycleExecutions - List of CycleExecution value for cycleExecutions.

lastPayment - LastPaymentDetails value for lastPayment.

nextBillingTime - String value for nextBillingTime.

finalPaymentTime - String value for finalPaymentTime.

lastFailedPayment - FailedPaymentDetails value for lastFailedPayment.

Method Detail

getOutstandingBalance

public Money getOutstandingBalance()

Getter for OutstandingBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setOutstandingBalance

public void setOutstandingBalance(Money outstandingBalance)

Setter for OutstandingBalance. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

outstandingBalance - Value for Money

getCycleExecutions

public List<CycleExecution> getCycleExecutions()

Getter for CycleExecutions. The trial and regular billing executions.

Returns:

Returns the List of CycleExecution

setCycleExecutions

public void setCycleExecutions(List<CycleExecution> cycleExecutions)

Setter for CycleExecutions. The trial and regular billing executions.

Parameters:

cycleExecutions - Value for List of CycleExecution

getLastPayment

public LastPaymentDetails getLastPayment()

Getter for LastPayment. The details for the last payment.

Returns:

Returns the LastPaymentDetails

setLastPayment

public void setLastPayment(LastPaymentDetails lastPayment)

Setter for LastPayment. The details for the last payment.

Parameters:

lastPayment - Value for LastPaymentDetails

getNextBillingTime

public String getNextBillingTime()

Getter for NextBillingTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Returns:

Returns the String

setNextBillingTime

public void setNextBillingTime(String nextBillingTime)

Setter for NextBillingTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Parameters:

nextBillingTime - Value for String

getFinalPaymentTime

public String getFinalPaymentTime()

Getter for FinalPaymentTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Returns:

Returns the String

setFinalPaymentTime

public void setFinalPaymentTime(String finalPaymentTime)

Setter for FinalPaymentTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.

Parameters:

finalPaymentTime - Value for String

getFailedPaymentsCount

public int getFailedPaymentsCount()

Getter for FailedPaymentsCount. The number of consecutive payment failures. Resets to `0` after a successful payment. If this reaches the `payment_failure_threshold` value, the subscription updates to the `SUSPENDED` state.

Returns:

Returns the int

setFailedPaymentsCount

public void setFailedPaymentsCount(int failedPaymentsCount)

Setter for FailedPaymentsCount. The number of consecutive payment failures. Resets to `0` after a successful payment. If this reaches the `payment_failure_threshold` value, the subscription updates to the `SUSPENDED` state.

Parameters:

failedPaymentsCount - Value for int

getLastFailedPayment

public FailedPaymentDetails getLastFailedPayment()

Getter for LastFailedPayment. The details for the failed payment of the subscription.

Returns:

Returns the FailedPaymentDetails

setLastFailedPayment

public void setLastFailedPayment(FailedPaymentDetails lastFailedPayment)

Setter for LastFailedPayment. The details for the failed payment of the subscription.

Parameters:

lastFailedPayment - Value for FailedPaymentDetails

toString

public String toString()

Converts this SubscriptionBillingInformation into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SubscriptionBillingInformation.Builder toBuilder()

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

Returns:

a new SubscriptionBillingInformation.Builder object