com.paypal.sdk.models

Class SubscriptionBillingCycle

java.lang.Object

com.paypal.sdk.models.SubscriptionBillingCycle

public class SubscriptionBillingCycle
extends Object

This is a model class for SubscriptionBillingCycle type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SubscriptionBillingCycle() Default constructor.
SubscriptionBillingCycle(Frequency frequency, TenureType tenureType, int sequence, SubscriptionPricingScheme pricingScheme, Integer totalCycles) Initialization constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionBillingCycle

public SubscriptionBillingCycle()

Default constructor.

SubscriptionBillingCycle

public SubscriptionBillingCycle(Frequency frequency,
                                TenureType tenureType,
                                int sequence,
                                SubscriptionPricingScheme pricingScheme,
                                Integer totalCycles)

Initialization constructor.

Parameters:

frequency - Frequency value for frequency.

tenureType - TenureType value for tenureType.

sequence - int value for sequence.

pricingScheme - SubscriptionPricingScheme value for pricingScheme.

totalCycles - Integer value for totalCycles.

Method Detail

getPricingScheme

public SubscriptionPricingScheme getPricingScheme()

Getter for PricingScheme. The pricing scheme details.

Returns:

Returns the SubscriptionPricingScheme

setPricingScheme

public void setPricingScheme(SubscriptionPricingScheme pricingScheme)

Setter for PricingScheme. The pricing scheme details.

Parameters:

pricingScheme - Value for SubscriptionPricingScheme

getFrequency

public Frequency getFrequency()

Getter for Frequency. The frequency of the billing cycle.

Returns:

Returns the Frequency

setFrequency

public void setFrequency(Frequency frequency)

Setter for Frequency. The frequency of the billing cycle.

Parameters:

frequency - Value for Frequency

getTenureType

public TenureType getTenureType()

Getter for TenureType. The tenure type of the billing cycle. In case of a plan having trial cycle, only 2 trial cycles are allowed per plan.

Returns:

Returns the TenureType

setTenureType

public void setTenureType(TenureType tenureType)

Setter for TenureType. The tenure type of the billing cycle. In case of a plan having trial cycle, only 2 trial cycles are allowed per plan.

Parameters:

tenureType - Value for TenureType

getSequence

public int 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 int

setSequence

public void setSequence(int 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 int

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

toString

public String toString()

Converts this SubscriptionBillingCycle into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SubscriptionBillingCycle.Builder toBuilder()

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

Returns:

a new SubscriptionBillingCycle.Builder object