Plan (rest-api-sdk 1.14.0 API)

java.lang.Object
- com.paypal.base.rest.PayPalModel
- - com.paypal.base.rest.PayPalResource
  - - com.paypal.api.payments.Plan

public class Plan
extends PayPalResource

Constructor Summary

Constructors
Constructor and Description

Plan()
Default Constructor

Plan(java.lang.String name, java.lang.String description, java.lang.String type)
Parameterized Constructor

Constructors
Constructor and Description
`Plan()` Default Constructor
`Plan(java.lang.String name, java.lang.String description, java.lang.String type)` Parameterized Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`Plan`	`create(APIContext apiContext)` Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI.
`Plan`	`create(java.lang.String accessToken)` Deprecated. Please use `create(APIContext)` instead.
`boolean`	`equals(java.lang.Object o)`
`static Plan`	`get(APIContext apiContext, java.lang.String planId)` Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI.
`static Plan`	`get(java.lang.String accessToken, java.lang.String planId)` Deprecated. Please use `get(APIContext, String)` instead.
`java.lang.String`	`getCreateTime()` Time when the billing plan was created.
`java.lang.String`	`getDescription()` Description of the billing plan.
`java.lang.String`	`getId()` Identifier of the billing plan.
`java.util.List<Links>`	`getLinks()`
`MerchantPreferences`	`getMerchantPreferences()` Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan.
`java.lang.String`	`getName()` Name of the billing plan.
`java.util.List<PaymentDefinition>`	`getPaymentDefinitions()` Array of payment definitions for this billing plan.
`java.lang.String`	`getState()` Status of the billing plan.
`java.util.List<Terms>`	`getTerms()` Array of terms for this billing plan.
`java.lang.String`	`getType()` Type of the billing plan.
`java.lang.String`	`getUpdateTime()` Time when this billing plan was updated.
`int`	`hashCode()`
`static PlanList`	`list(APIContext apiContext, java.util.Map<java.lang.String,java.lang.String> containerMap)` List billing plans according to optional query string parameters specified.
`static PlanList`	`list(java.lang.String accessToken, java.util.Map<java.lang.String,java.lang.String> containerMap)` Deprecated. Please use `list(APIContext, Map)` instead.
`Plan`	`setCreateTime(java.lang.String createTime)` Time when the billing plan was created.
`Plan`	`setDescription(java.lang.String description)` Description of the billing plan.
`Plan`	`setId(java.lang.String id)` Identifier of the billing plan.
`Plan`	`setLinks(java.util.List<Links> links)`
`Plan`	`setMerchantPreferences(MerchantPreferences merchantPreferences)` Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan.
`Plan`	`setName(java.lang.String name)` Name of the billing plan.
`Plan`	`setPaymentDefinitions(java.util.List<PaymentDefinition> paymentDefinitions)` Array of payment definitions for this billing plan.
`Plan`	`setState(java.lang.String state)` Status of the billing plan.
`Plan`	`setTerms(java.util.List<Terms> terms)` Array of terms for this billing plan.
`Plan`	`setType(java.lang.String type)` Type of the billing plan.
`Plan`	`setUpdateTime(java.lang.String updateTime)` Time when this billing plan was updated.
`void`	`update(APIContext apiContext, java.util.List<Patch> patchRequest)` Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI.
`void`	`update(java.lang.String accessToken, java.util.List<Patch> patchRequest)` Deprecated. Please use `update(APIContext, List)` instead.

Methods inherited from class com.paypal.base.rest.PayPalResource
configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel
toJSON, toString

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

- Constructor Detail
  - Plan
```
public Plan()
```
    Default Constructor
  - Plan
```
public Plan(java.lang.String name,
            java.lang.String description,
            java.lang.String type)
```
    Parameterized Constructor
- Method Detail
  - get
```
public static Plan get(java.lang.String accessToken,
                       java.lang.String planId)
                throws PayPalRESTException
```
    Deprecated. Please use get(APIContext, String) instead.
    
    Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    planId - String
    
    Returns:
    
    Plan
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Plan get(APIContext apiContext,
                       java.lang.String planId)
                throws PayPalRESTException
```
    Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    planId - String
    
    Returns:
    
    Plan
    
    Throws:
    
    PayPalRESTException
  - create
```
public Plan create(java.lang.String accessToken)
            throws PayPalRESTException
```
    Deprecated. Please use create(APIContext) instead.
    
    Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Returns:
    
    Plan
    
    Throws:
    
    PayPalRESTException
  - create
```
public Plan create(APIContext apiContext)
            throws PayPalRESTException
```
    Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    Plan
    
    Throws:
    
    PayPalRESTException
  - update
```
public void update(java.lang.String accessToken,
                   java.util.List<Patch> patchRequest)
            throws PayPalRESTException
```
    Deprecated. Please use update(APIContext, List) instead.
    
    Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI. In addition, pass a patch object in the request JSON that specifies the operation to perform, field to update, and new value for each update.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    patchRequest - PatchRequest
    
    Throws:
    
    PayPalRESTException
  - update
```
public void update(APIContext apiContext,
                   java.util.List<Patch> patchRequest)
            throws PayPalRESTException
```
    Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI. In addition, pass a patch object in the request JSON that specifies the operation to perform, field to update, and new value for each update.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    patchRequest - PatchRequest
    
    Throws:
    
    PayPalRESTException
  - list
```
public static PlanList list(java.lang.String accessToken,
                            java.util.Map<java.lang.String,java.lang.String> containerMap)
                     throws PayPalRESTException
```
    Deprecated. Please use list(APIContext, Map) instead.
    
    List billing plans according to optional query string parameters specified.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    containerMap - Map
    
    Returns:
    
    PlanList
    
    Throws:
    
    PayPalRESTException
  - list
```
public static PlanList list(APIContext apiContext,
                            java.util.Map<java.lang.String,java.lang.String> containerMap)
                     throws PayPalRESTException
```
    List billing plans according to optional query string parameters specified.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    containerMap - Map
    
    Returns:
    
    PlanList
    
    Throws:
    
    PayPalRESTException
  - getId
```
public java.lang.String getId()
```
    Identifier of the billing plan. 128 characters max.
  - getName
```
public java.lang.String getName()
```
    Name of the billing plan. 128 characters max.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of the billing plan. 128 characters max.
  - getType
```
public java.lang.String getType()
```
    Type of the billing plan. Allowed values: `FIXED`, `INFINITE`.
  - getState
```
public java.lang.String getState()
```
    Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`.
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getPaymentDefinitions
```
public java.util.List<PaymentDefinition> getPaymentDefinitions()
```
    Array of payment definitions for this billing plan.
  - getTerms
```
public java.util.List<Terms> getTerms()
```
    Array of terms for this billing plan.
  - getMerchantPreferences
```
public MerchantPreferences getMerchantPreferences()
```
    Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan.
  - getLinks
```
public java.util.List<Links> getLinks()
```
  - setId
```
public Plan setId(java.lang.String id)
```
    Identifier of the billing plan. 128 characters max.
    
    Returns:
    
    this
  - setName
```
public Plan setName(java.lang.String name)
```
    Name of the billing plan. 128 characters max.
    
    Returns:
    
    this
  - setDescription
```
public Plan setDescription(java.lang.String description)
```
    Description of the billing plan. 128 characters max.
    
    Returns:
    
    this
  - setType
```
public Plan setType(java.lang.String type)
```
    Type of the billing plan. Allowed values: `FIXED`, `INFINITE`.
    
    Returns:
    
    this
  - setState
```
public Plan setState(java.lang.String state)
```
    Status of the billing plan. Allowed values: `CREATED`, `ACTIVE`, `INACTIVE`, and `DELETED`.
    
    Returns:
    
    this
  - setCreateTime
```
public Plan setCreateTime(java.lang.String createTime)
```
    Time when the billing plan was created. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setUpdateTime
```
public Plan setUpdateTime(java.lang.String updateTime)
```
    Time when this billing plan was updated. Format YYYY-MM-DDTimeTimezone, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setPaymentDefinitions
```
public Plan setPaymentDefinitions(java.util.List<PaymentDefinition> paymentDefinitions)
```
    Array of payment definitions for this billing plan.
    
    Returns:
    
    this
  - setTerms
```
public Plan setTerms(java.util.List<Terms> terms)
```
    Array of terms for this billing plan.
    
    Returns:
    
    this
  - setMerchantPreferences
```
public Plan setMerchantPreferences(MerchantPreferences merchantPreferences)
```
    Specific preferences such as: set up fee, max fail attempts, autobill amount, and others that are configured for this billing plan.
    
    Returns:
    
    this
  - setLinks
```
public Plan setLinks(java.util.List<Links> links)
```
    Returns:
    
    this
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class PayPalModel
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
    Overrides:
    
    canEqual in class PayPalModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class PayPalModel

Class Plan

Constructor Summary

Method Summary

Methods inherited from class com.paypal.base.rest.PayPalResource

Methods inherited from class com.paypal.base.rest.PayPalModel

Methods inherited from class java.lang.Object

Constructor Detail

Plan

Plan

Method Detail

get

get

create

create

update

update

list

list

getId

getName

getDescription

getType

getState

getCreateTime

getUpdateTime

getPaymentDefinitions

getTerms

getMerchantPreferences

getLinks

setId

setName

setDescription

setType

setState

setCreateTime

setUpdateTime

setPaymentDefinitions

setTerms

setMerchantPreferences

setLinks

equals

canEqual

hashCode