com.paypal.sdk.models

Class Plan

java.lang.Object

com.paypal.sdk.models.Plan

public class Plan
extends Object

This is a model class for Plan type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Plan() Default constructor.
Plan(List<BillingCycle> billingCycles, OneTimeCharge oneTimeCharges, JsonValue product, String name) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
List<BillingCycle>	getBillingCycles() Getter for BillingCycles.
String	getName() Getter for Name.
OneTimeCharge	getOneTimeCharges() Getter for OneTimeCharges.
JsonValue	getProduct() Getter for Product.
void	setBillingCycles(List<BillingCycle> billingCycles) Setter for BillingCycles.
void	setName(String name) Setter for Name.
void	setOneTimeCharges(OneTimeCharge oneTimeCharges) Setter for OneTimeCharges.
void	setProduct(JsonValue product) Setter for Product.
Plan.Builder	toBuilder() Builds a new Plan.Builder object.
String	toString() Converts this Plan into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Plan

public Plan()

Default constructor.

Plan

public Plan(List<BillingCycle> billingCycles,
            OneTimeCharge oneTimeCharges,
            JsonValue product,
            String name)

Initialization constructor.

Parameters:

billingCycles - List of BillingCycle value for billingCycles.

oneTimeCharges - OneTimeCharge value for oneTimeCharges.

product - JsonValue value for product.

name - String value for name.

Method Detail

getBillingCycles

public List<BillingCycle> getBillingCycles()

Getter for BillingCycles. An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.

Returns:

Returns the List of BillingCycle

setBillingCycles

public void setBillingCycles(List<BillingCycle> billingCycles)

Setter for BillingCycles. An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.

Parameters:

billingCycles - Value for List of BillingCycle

getProduct

public JsonValue getProduct()

Getter for Product. Product details associated with any one-time product purchase.

Returns:

Returns the JsonValue

setProduct

public void setProduct(JsonValue product)

Setter for Product. Product details associated with any one-time product purchase.

Parameters:

product - Value for JsonValue

getOneTimeCharges

public OneTimeCharge getOneTimeCharges()

Getter for OneTimeCharges. The one-time charge info at the time of checkout.

Returns:

Returns the OneTimeCharge

setOneTimeCharges

public void setOneTimeCharges(OneTimeCharge oneTimeCharges)

Setter for OneTimeCharges. The one-time charge info at the time of checkout.

Parameters:

oneTimeCharges - Value for OneTimeCharge

getName

public String getName()

Getter for Name. Name of the recurring plan.

Returns:

Returns the String

setName

public void setName(String name)

Setter for Name. Name of the recurring plan.

Parameters:

name - Value for String

toString

public String toString()

Converts this Plan into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Plan.Builder toBuilder()

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

Returns:

a new Plan.Builder object