com.paypal.sdk.models

Class BillingCycleOverride

java.lang.Object

com.paypal.sdk.models.BillingCycleOverride

public class BillingCycleOverride
extends Object

This is a model class for BillingCycleOverride type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
BillingCycleOverride() Default constructor.
BillingCycleOverride(int sequence, SubscriptionPricingScheme pricingScheme, Integer totalCycles) Initialization constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BillingCycleOverride

public BillingCycleOverride()

Default constructor.

BillingCycleOverride

public BillingCycleOverride(int sequence,
                            SubscriptionPricingScheme pricingScheme,
                            Integer totalCycles)

Initialization constructor.

Parameters:

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

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BillingCycleOverride.Builder toBuilder()

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

Returns:

a new BillingCycleOverride.Builder object