com.paypal.sdk.models

Class BillingCycle

java.lang.Object

com.paypal.sdk.models.BillingCycle

public class BillingCycle
extends Object

This is a model class for BillingCycle type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
BillingCycle() Default constructor.
BillingCycle(TenureType tenureType, PricingScheme pricingScheme, JsonValue frequency, Integer totalCycles, Integer sequence, String startDate) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
JsonValue	getFrequency() Getter for Frequency.
PricingScheme	getPricingScheme() Getter for PricingScheme.
Integer	getSequence() Getter for Sequence.
String	getStartDate() Getter for StartDate.
TenureType	getTenureType() Getter for TenureType.
Integer	getTotalCycles() Getter for TotalCycles.
void	setFrequency(JsonValue frequency) Setter for Frequency.
void	setPricingScheme(PricingScheme pricingScheme) Setter for PricingScheme.
void	setSequence(Integer sequence) Setter for Sequence.
void	setStartDate(String startDate) Setter for StartDate.
void	setTenureType(TenureType tenureType) Setter for TenureType.
void	setTotalCycles(Integer totalCycles) Setter for TotalCycles.
BillingCycle.Builder	toBuilder() Builds a new BillingCycle.Builder object.
String	toString() Converts this BillingCycle into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

BillingCycle

public BillingCycle()

Default constructor.

BillingCycle

public BillingCycle(TenureType tenureType,
                    PricingScheme pricingScheme,
                    JsonValue frequency,
                    Integer totalCycles,
                    Integer sequence,
                    String startDate)

Initialization constructor.

Parameters:

tenureType - TenureType value for tenureType.

pricingScheme - PricingScheme value for pricingScheme.

frequency - JsonValue value for frequency.

totalCycles - Integer value for totalCycles.

sequence - Integer value for sequence.

startDate - String value for startDate.

Method Detail

getTenureType

public TenureType getTenureType()

Getter for TenureType. The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.

Returns:

Returns the TenureType

setTenureType

public void setTenureType(TenureType tenureType)

Setter for TenureType. The tenure type of the billing cycle identifies if the billing cycle is a trial(free or discounted) or regular billing cycle.

Parameters:

tenureType - Value for TenureType

getPricingScheme

public PricingScheme getPricingScheme()

Getter for PricingScheme. The pricing scheme details.

Returns:

Returns the PricingScheme

setPricingScheme

public void setPricingScheme(PricingScheme pricingScheme)

Setter for PricingScheme. The pricing scheme details.

Parameters:

pricingScheme - Value for PricingScheme

getFrequency

public JsonValue getFrequency()

Getter for Frequency. The frequency details for this billing cycle.

Returns:

Returns the JsonValue

setFrequency

public void setFrequency(JsonValue frequency)

Setter for Frequency. The frequency details for this billing cycle.

Parameters:

frequency - Value for JsonValue

getTotalCycles

public Integer getTotalCycles()

Getter for TotalCycles. The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

Returns:

Returns the Integer

setTotalCycles

public void setTotalCycles(Integer totalCycles)

Setter for TotalCycles. The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

Parameters:

totalCycles - Value for Integer

getSequence

public Integer getSequence()

Getter for Sequence. The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial cycle runs before the regular cycle.

Returns:

Returns the Integer

setSequence

public void setSequence(Integer sequence)

Setter for Sequence. The order in which this cycle is to run among other billing cycles. For example, a trial billing cycle has a `sequence` of `1` while a regular billing cycle has a `sequence` of `2`, so that trial cycle runs before the regular cycle.

Parameters:

sequence - Value for Integer

getStartDate

public String getStartDate()

Getter for StartDate. The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Returns:

Returns the String

setStartDate

public void setStartDate(String startDate)

Setter for StartDate. The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Parameters:

startDate - Value for String

toString

public String toString()

Converts this BillingCycle into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BillingCycle.Builder toBuilder()

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

Returns:

a new BillingCycle.Builder object