com.paypal.sdk.models

Class PlanRequest

java.lang.Object

com.paypal.sdk.models.PlanRequest

public class PlanRequest
extends Object

This is a model class for PlanRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PlanRequest() Default constructor.
PlanRequest(String productId, String name, List<SubscriptionBillingCycle> billingCycles, PaymentPreferences paymentPreferences, PlanRequestStatus status, String description, MerchantPreferences merchantPreferences, Taxes taxes, Boolean quantitySupported) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
List<SubscriptionBillingCycle>	getBillingCycles() Getter for BillingCycles.
String	getDescription() Getter for Description.
MerchantPreferences	getMerchantPreferences() Getter for MerchantPreferences.
String	getName() Getter for Name.
PaymentPreferences	getPaymentPreferences() Getter for PaymentPreferences.
String	getProductId() Getter for ProductId.
Boolean	getQuantitySupported() Getter for QuantitySupported.
PlanRequestStatus	getStatus() Getter for Status.
Taxes	getTaxes() Getter for Taxes.
void	setBillingCycles(List<SubscriptionBillingCycle> billingCycles) Setter for BillingCycles.
void	setDescription(String description) Setter for Description.
void	setMerchantPreferences(MerchantPreferences merchantPreferences) Setter for MerchantPreferences.
void	setName(String name) Setter for Name.
void	setPaymentPreferences(PaymentPreferences paymentPreferences) Setter for PaymentPreferences.
void	setProductId(String productId) Setter for ProductId.
void	setQuantitySupported(Boolean quantitySupported) Setter for QuantitySupported.
void	setStatus(PlanRequestStatus status) Setter for Status.
void	setTaxes(Taxes taxes) Setter for Taxes.
PlanRequest.Builder	toBuilder() Builds a new PlanRequest.Builder object.
String	toString() Converts this PlanRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanRequest

public PlanRequest()

Default constructor.

PlanRequest

public PlanRequest(String productId,
                   String name,
                   List<SubscriptionBillingCycle> billingCycles,
                   PaymentPreferences paymentPreferences,
                   PlanRequestStatus status,
                   String description,
                   MerchantPreferences merchantPreferences,
                   Taxes taxes,
                   Boolean quantitySupported)

Initialization constructor.

Parameters:

productId - String value for productId.

name - String value for name.

billingCycles - List of SubscriptionBillingCycle value for billingCycles.

paymentPreferences - PaymentPreferences value for paymentPreferences.

status - PlanRequestStatus value for status.

description - String value for description.

merchantPreferences - MerchantPreferences value for merchantPreferences.

taxes - Taxes value for taxes.

quantitySupported - Boolean value for quantitySupported.

Method Detail

getProductId

public String getProductId()

Getter for ProductId. The ID of the product created through Catalog Products API.

Returns:

Returns the String

setProductId

public void setProductId(String productId)

Setter for ProductId. The ID of the product created through Catalog Products API.

Parameters:

productId - Value for String

getName

public String getName()

Getter for Name. The plan name.

Returns:

Returns the String

setName

public void setName(String name)

Setter for Name. The plan name.

Parameters:

name - Value for String

getStatus

public PlanRequestStatus getStatus()

Getter for Status. The initial state of the plan. Allowed input values are CREATED and ACTIVE.

Returns:

Returns the PlanRequestStatus

setStatus

public void setStatus(PlanRequestStatus status)

Setter for Status. The initial state of the plan. Allowed input values are CREATED and ACTIVE.

Parameters:

status - Value for PlanRequestStatus

getDescription

public String getDescription()

Getter for Description. The detailed description of the plan.

Returns:

Returns the String

setDescription

public void setDescription(String description)

Setter for Description. The detailed description of the plan.

Parameters:

description - Value for String

getBillingCycles

public List<SubscriptionBillingCycle> 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 SubscriptionBillingCycle

setBillingCycles

public void setBillingCycles(List<SubscriptionBillingCycle> 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 SubscriptionBillingCycle

getPaymentPreferences

public PaymentPreferences getPaymentPreferences()

Getter for PaymentPreferences. The payment preferences for a subscription.

Returns:

Returns the PaymentPreferences

setPaymentPreferences

public void setPaymentPreferences(PaymentPreferences paymentPreferences)

Setter for PaymentPreferences. The payment preferences for a subscription.

Parameters:

paymentPreferences - Value for PaymentPreferences

getMerchantPreferences

public MerchantPreferences getMerchantPreferences()

Getter for MerchantPreferences. The merchant preferences for a subscription.

Returns:

Returns the MerchantPreferences

setMerchantPreferences

public void setMerchantPreferences(MerchantPreferences merchantPreferences)

Setter for MerchantPreferences. The merchant preferences for a subscription.

Parameters:

merchantPreferences - Value for MerchantPreferences

getTaxes

public Taxes getTaxes()

Getter for Taxes. The tax details.

Returns:

Returns the Taxes

setTaxes

public void setTaxes(Taxes taxes)

Setter for Taxes. The tax details.

Parameters:

taxes - Value for Taxes

getQuantitySupported

public Boolean getQuantitySupported()

Getter for QuantitySupported. Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

Returns:

Returns the Boolean

setQuantitySupported

public void setQuantitySupported(Boolean quantitySupported)

Setter for QuantitySupported. Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

Parameters:

quantitySupported - Value for Boolean

toString

public String toString()

Converts this PlanRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public PlanRequest.Builder toBuilder()

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

Returns:

a new PlanRequest.Builder object