BillingPlan (PayPal Server SDK 2.2.0 API)

java.lang.Object
- com.paypal.sdk.models.BillingPlan

```
public class BillingPlan
extends Object
```
This is a model class for BillingPlan type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BillingPlan.Builder
Class to build instances of BillingPlan.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BillingPlan.Builder` Class to build instances of `BillingPlan`.

Constructor Summary

Constructors
Constructor and Description
`BillingPlan()` Default constructor.
`BillingPlan(String id, String productId, String name, SubscriptionPlanStatus status, String description, List<SubscriptionBillingCycle> billingCycles, PaymentPreferences paymentPreferences, MerchantPreferences merchantPreferences, Taxes taxes, Boolean quantitySupported, String createTime, String updateTime, List<LinkDescription> links)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<SubscriptionBillingCycle>`	`getBillingCycles()` Getter for BillingCycles.
`String`	`getCreateTime()` Getter for CreateTime.
`String`	`getDescription()` Getter for Description.
`String`	`getId()` Getter for Id.
`List<LinkDescription>`	`getLinks()` Getter for Links.
`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.
`SubscriptionPlanStatus`	`getStatus()` Getter for Status.
`Taxes`	`getTaxes()` Getter for Taxes.
`String`	`getUpdateTime()` Getter for UpdateTime.
`void`	`setBillingCycles(List<SubscriptionBillingCycle> billingCycles)` Setter for BillingCycles.
`void`	`setCreateTime(String createTime)` Setter for CreateTime.
`void`	`setDescription(String description)` Setter for Description.
`void`	`setId(String id)` Setter for Id.
`void`	`setLinks(List<LinkDescription> links)` Setter for Links.
`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(SubscriptionPlanStatus status)` Setter for Status.
`void`	`setTaxes(Taxes taxes)` Setter for Taxes.
`void`	`setUpdateTime(String updateTime)` Setter for UpdateTime.
`BillingPlan.Builder`	`toBuilder()` Builds a new `BillingPlan.Builder` object.
`String`	`toString()` Converts this BillingPlan into string format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BillingPlan
```
public BillingPlan()
```
    Default constructor.
  - BillingPlan
```
public BillingPlan(String id,
                   String productId,
                   String name,
                   SubscriptionPlanStatus status,
                   String description,
                   List<SubscriptionBillingCycle> billingCycles,
                   PaymentPreferences paymentPreferences,
                   MerchantPreferences merchantPreferences,
                   Taxes taxes,
                   Boolean quantitySupported,
                   String createTime,
                   String updateTime,
                   List<LinkDescription> links)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    productId - String value for productId.
    
    name - String value for name.
    
    status - SubscriptionPlanStatus value for status.
    
    description - String value for description.
    
    billingCycles - List of SubscriptionBillingCycle value for billingCycles.
    
    paymentPreferences - PaymentPreferences value for paymentPreferences.
    
    merchantPreferences - MerchantPreferences value for merchantPreferences.
    
    taxes - Taxes value for taxes.
    
    quantitySupported - Boolean value for quantitySupported.
    
    createTime - String value for createTime.
    
    updateTime - String value for updateTime.
    
    links - List of LinkDescription value for links.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. The unique PayPal-generated ID for the plan.
    
    Returns:
    
    Returns the String
  - setId
```
public void setId(String id)
```
    Setter for Id. The unique PayPal-generated ID for the plan.
    
    Parameters:
    
    id - Value for String
  - getProductId
```
public String getProductId()
```
    Getter for ProductId. The ID for the product.
    
    Returns:
    
    Returns the String
  - setProductId
```
public void setProductId(String productId)
```
    Setter for ProductId. The ID for the product.
    
    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 SubscriptionPlanStatus getStatus()
```
    Getter for Status. The plan status.
    
    Returns:
    
    Returns the SubscriptionPlanStatus
  - setStatus
```
public void setStatus(SubscriptionPlanStatus status)
```
    Setter for Status. The plan status.
    
    Parameters:
    
    status - Value for SubscriptionPlanStatus
  - 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
  - getCreateTime
```
public String getCreateTime()
```
    Getter for CreateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Returns:
    
    Returns the String
  - setCreateTime
```
public void setCreateTime(String createTime)
```
    Setter for CreateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Parameters:
    
    createTime - Value for String
  - getUpdateTime
```
public String getUpdateTime()
```
    Getter for UpdateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Returns:
    
    Returns the String
  - setUpdateTime
```
public void setUpdateTime(String updateTime)
```
    Setter for UpdateTime. The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates.
    
    Parameters:
    
    updateTime - Value for String
  - getLinks
```
public List<LinkDescription> getLinks()
```
    Getter for Links. An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
    
    Returns:
    
    Returns the List of LinkDescription
  - setLinks
```
public void setLinks(List<LinkDescription> links)
```
    Setter for Links. An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
    
    Parameters:
    
    links - Value for List of LinkDescription
  - toString
```
public String toString()
```
    Converts this BillingPlan into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public BillingPlan.Builder toBuilder()
```
    Builds a new BillingPlan.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new BillingPlan.Builder object

Class BillingPlan

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BillingPlan

BillingPlan

Method Detail

getId

setId

getProductId

setProductId

getName

setName

getStatus

setStatus

getDescription

setDescription

getBillingCycles

setBillingCycles

getPaymentPreferences

setPaymentPreferences

getMerchantPreferences

setMerchantPreferences

getTaxes

setTaxes

getQuantitySupported

setQuantitySupported

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getLinks

setLinks

toString

toBuilder