com.paypal.api.payments

Class Agreement

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Agreement

public class Agreement
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Agreement() Default Constructor
Agreement(java.lang.String name, java.lang.String description, java.lang.String startDate, Payer payer, Plan plan) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
void	billBalance(APIContext apiContext, AgreementStateDescriptor agreementStateDescriptor) Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI.
void	billBalance(java.lang.String accessToken, AgreementStateDescriptor agreementStateDescriptor) Deprecated. Please use billBalance(APIContext, AgreementStateDescriptor) instead.
void	cancel(APIContext apiContext, AgreementStateDescriptor agreementStateDescriptor) Cancel a billing agreement by passing the ID of the agreement to the request URI.
void	cancel(java.lang.String accessToken, AgreementStateDescriptor agreementStateDescriptor) Deprecated. Please use cancel(APIContext, AgreementStateDescriptor) instead.
protected boolean	canEqual(java.lang.Object other)
Agreement	create(APIContext apiContext) Create a new billing agreement by passing the details for the agreement, including the name, description, start date, payer, and billing plan in the request JSON.
Agreement	create(java.lang.String accessToken) Deprecated. Please use create(APIContext) instead.
boolean	equals(java.lang.Object o)
static Agreement	execute(APIContext apiContext, java.lang.String token) Execute a billing agreement after buyer approval by passing the payment token to the request URI.
Agreement	execute(java.lang.String accessToken) Deprecated. Please use execute(APIContext, String) instead.
static Agreement	get(APIContext apiContext, java.lang.String agreementId) Retrieve details for a particular billing agreement by passing the ID of the agreement to the request URI.
static Agreement	get(java.lang.String accessToken, java.lang.String agreementId) Deprecated. Please use get(APIContext, String) instead.
AgreementDetails	getAgreementDetails() Details of the agreement.
java.lang.String	getCreateTime() Date and time that this resource was created.
java.lang.String	getDescription() Description of the agreement.
java.lang.String	getId() Identifier of the agreement.
java.util.List<Links>	getLinks()
java.lang.String	getName() Name of the agreement.
java.util.List<OverrideChargeModel>	getOverrideChargeModels() Array of override_charge_model for this agreement if needed to change the default models from the billing plan.
MerchantPreferences	getOverrideMerchantPreferences() Default merchant preferences from the billing plan are used, unless override preferences are provided here.
Payer	getPayer() Details of the buyer who is enrolling in this agreement.
Plan	getPlan() Plan details for this agreement.
Address	getShippingAddress() Shipping address object of the agreement, which should be provided if it is different from the default address.
java.lang.String	getStartDate() Start date of the agreement.
java.lang.String	getState() State of the agreement
java.lang.String	getToken() Payment token
java.lang.String	getUpdateTime() Date and time that this resource was updated.
int	hashCode()
void	reActivate(APIContext apiContext, AgreementStateDescriptor agreementStateDescriptor) Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI.
void	reActivate(java.lang.String accessToken, AgreementStateDescriptor agreementStateDescriptor) Deprecated. Please use reActivate(APIContext, AgreementStateDescriptor) instead.
Agreement	setAgreementDetails(AgreementDetails agreementDetails) Details of the agreement.
void	setBalance(APIContext apiContext, Currency currency) Set the balance for an agreement by passing the ID of the agreement to the request URI.
void	setBalance(java.lang.String accessToken, Currency currency) Deprecated. Please use setBalance(APIContext, Currency) instead.
Agreement	setCreateTime(java.lang.String createTime) Date and time that this resource was created.
Agreement	setDescription(java.lang.String description) Description of the agreement.
Agreement	setId(java.lang.String id) Identifier of the agreement.
Agreement	setLinks(java.util.List<Links> links)
Agreement	setName(java.lang.String name) Name of the agreement.
Agreement	setOverrideChargeModels(java.util.List<OverrideChargeModel> overrideChargeModels) Array of override_charge_model for this agreement if needed to change the default models from the billing plan.
Agreement	setOverrideMerchantPreferences(MerchantPreferences overrideMerchantPreferences) Default merchant preferences from the billing plan are used, unless override preferences are provided here.
Agreement	setPayer(Payer payer) Details of the buyer who is enrolling in this agreement.
Agreement	setPlan(Plan plan) Plan details for this agreement.
Agreement	setShippingAddress(Address shippingAddress) Shipping address object of the agreement, which should be provided if it is different from the default address.
Agreement	setStartDate(java.lang.String startDate) Start date of the agreement.
Agreement	setState(java.lang.String state) State of the agreement
Agreement	setToken(java.lang.String token) Payment token
Agreement	setUpdateTime(java.lang.String updateTime) Date and time that this resource was updated.
void	suspend(APIContext apiContext, AgreementStateDescriptor agreementStateDescriptor) Suspend a particular billing agreement by passing the ID of the agreement to the request URI.
void	suspend(java.lang.String accessToken, AgreementStateDescriptor agreementStateDescriptor) Deprecated. Please use suspend(APIContext, AgreementStateDescriptor) instead.
static AgreementTransactions	transactions(APIContext apiContext, java.lang.String agreementId, java.util.Date startDate, java.util.Date endDate) List transactions for a billing agreement by passing the ID of the agreement, as well as the start and end dates of the range of transactions to list, to the request URI.
static AgreementTransactions	transactions(java.lang.String accessToken, java.lang.String agreementId, java.util.Date startDate, java.util.Date endDate) Deprecated. Please use transactions(APIContext, String, Date, Date) instead.
Agreement	update(APIContext apiContext, java.util.List<Patch> patchRequest) Update details of a billing agreement, such as the description, shipping address, and start date, by passing the ID of the agreement to the request URI.
Agreement	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

Agreement

public Agreement()

Default Constructor

Agreement

public Agreement(java.lang.String name,
                 java.lang.String description,
                 java.lang.String startDate,
                 Payer payer,
                 Plan plan)

Parameterized Constructor

Method Detail

create

public Agreement create(java.lang.String accessToken)
                 throws PayPalRESTException,
                        java.net.MalformedURLException,
                        java.io.UnsupportedEncodingException

Deprecated. Please use create(APIContext) instead.

Create a new billing agreement by passing the details for the agreement, including the name, description, start date, payer, and billing plan in the request JSON.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Agreement

Throws:

PayPalRESTException

java.io.UnsupportedEncodingException

java.net.MalformedURLException

create

public Agreement create(APIContext apiContext)
                 throws PayPalRESTException,
                        java.net.MalformedURLException,
                        java.io.UnsupportedEncodingException

Create a new billing agreement by passing the details for the agreement, including the name, description, start date, payer, and billing plan in the request JSON.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Agreement

Throws:

PayPalRESTException

java.net.MalformedURLException

java.io.UnsupportedEncodingException

execute

public Agreement execute(java.lang.String accessToken)
                  throws PayPalRESTException

Deprecated. Please use execute(APIContext, String) instead.

Execute a billing agreement after buyer approval by passing the payment token to the request URI.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Agreement

Throws:

PayPalRESTException

execute

public static Agreement execute(APIContext apiContext,
                                java.lang.String token)
                         throws PayPalRESTException

Execute a billing agreement after buyer approval by passing the payment token to the request URI.

Parameters:

apiContext - APIContext used for the API call.

token - payment token (e.g., EC-0JP008296V451950C)

Returns:

Agreement

Throws:

PayPalRESTException

get

public static Agreement get(java.lang.String accessToken,
                            java.lang.String agreementId)
                     throws PayPalRESTException

Deprecated. Please use get(APIContext, String) instead.

Retrieve details for a particular billing agreement by passing the ID of the agreement to the request URI.

Parameters:

accessToken - Access Token used for the API call.

agreementId - String

Returns:

Agreement

Throws:

PayPalRESTException

get

public static Agreement get(APIContext apiContext,
                            java.lang.String agreementId)
                     throws PayPalRESTException

Retrieve details for a particular billing agreement by passing the ID of the agreement to the request URI.

Parameters:

apiContext - APIContext used for the API call.

agreementId - String

Returns:

Agreement

Throws:

PayPalRESTException

update

public Agreement update(java.lang.String accessToken,
                        java.util.List<Patch> patchRequest)
                 throws PayPalRESTException

Deprecated. Please use update(APIContext, List) instead.

Update details of a billing agreement, such as the description, shipping address, and start date, by passing the ID of the agreement to the request URI.

Parameters:

accessToken - Access Token used for the API call.

patchRequest - PatchRequest

Returns:

Agreement

Throws:

PayPalRESTException

update

public Agreement update(APIContext apiContext,
                        java.util.List<Patch> patchRequest)
                 throws PayPalRESTException

Update details of a billing agreement, such as the description, shipping address, and start date, by passing the ID of the agreement to the request URI.

Parameters:

apiContext - APIContext used for the API call.

patchRequest - PatchRequest (list of patches)

Returns:

Agreement

Throws:

PayPalRESTException

suspend

public void suspend(java.lang.String accessToken,
                    AgreementStateDescriptor agreementStateDescriptor)
             throws PayPalRESTException

Deprecated. Please use suspend(APIContext, AgreementStateDescriptor) instead.

Suspend a particular billing agreement by passing the ID of the agreement to the request URI.

Parameters:

accessToken - Access Token used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

suspend

public void suspend(APIContext apiContext,
                    AgreementStateDescriptor agreementStateDescriptor)
             throws PayPalRESTException

Suspend a particular billing agreement by passing the ID of the agreement to the request URI.

Parameters:

apiContext - APIContext used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

reActivate

public void reActivate(java.lang.String accessToken,
                       AgreementStateDescriptor agreementStateDescriptor)
                throws PayPalRESTException

Deprecated. Please use reActivate(APIContext, AgreementStateDescriptor) instead.

Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI. In addition, pass an agreement_state_descriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement.

Parameters:

accessToken - Access Token used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

reActivate

public void reActivate(APIContext apiContext,
                       AgreementStateDescriptor agreementStateDescriptor)
                throws PayPalRESTException

Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI. In addition, pass an agreement_state_descriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement.

Parameters:

apiContext - APIContext used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

cancel

public void cancel(java.lang.String accessToken,
                   AgreementStateDescriptor agreementStateDescriptor)
            throws PayPalRESTException

Deprecated. Please use cancel(APIContext, AgreementStateDescriptor) instead.

Cancel a billing agreement by passing the ID of the agreement to the request URI. In addition, pass an agreement_state_descriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement.

Parameters:

accessToken - Access Token used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

cancel

public void cancel(APIContext apiContext,
                   AgreementStateDescriptor agreementStateDescriptor)
            throws PayPalRESTException

Cancel a billing agreement by passing the ID of the agreement to the request URI. In addition, pass an agreement_state_descriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement.

Parameters:

apiContext - APIContext used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

billBalance

public void billBalance(java.lang.String accessToken,
                        AgreementStateDescriptor agreementStateDescriptor)
                 throws PayPalRESTException

Deprecated. Please use billBalance(APIContext, AgreementStateDescriptor) instead.

Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI. In addition, pass an agreement_state_descriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement.

Parameters:

accessToken - Access Token used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

billBalance

public void billBalance(APIContext apiContext,
                        AgreementStateDescriptor agreementStateDescriptor)
                 throws PayPalRESTException

Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI. In addition, pass an agreement_state_descriptor object in the request JSON that includes a note about the reason for changing the state of the agreement and the amount and currency for the agreement.

Parameters:

apiContext - APIContext used for the API call.

agreementStateDescriptor - AgreementStateDescriptor

Throws:

PayPalRESTException

setBalance

public void setBalance(java.lang.String accessToken,
                       Currency currency)
                throws PayPalRESTException

Deprecated. Please use setBalance(APIContext, Currency) instead.

Set the balance for an agreement by passing the ID of the agreement to the request URI. In addition, pass a common_currency object in the request JSON that specifies the currency type and value of the balance.

Parameters:

accessToken - Access Token used for the API call.

currency - Currency

Throws:

PayPalRESTException

setBalance

public void setBalance(APIContext apiContext,
                       Currency currency)
                throws PayPalRESTException

Set the balance for an agreement by passing the ID of the agreement to the request URI. In addition, pass a common_currency object in the request JSON that specifies the currency type and value of the balance.

Parameters:

apiContext - APIContext used for the API call.

currency - Currency

Throws:

PayPalRESTException

transactions

public static AgreementTransactions transactions(java.lang.String accessToken,
                                                 java.lang.String agreementId,
                                                 java.util.Date startDate,
                                                 java.util.Date endDate)
                                          throws PayPalRESTException

Deprecated. Please use transactions(APIContext, String, Date, Date) instead.

List transactions for a billing agreement by passing the ID of the agreement, as well as the start and end dates of the range of transactions to list, to the request URI.

Parameters:

accessToken - Access Token used for the API call.

agreementId - String

Returns:

AgreementTransactions

Throws:

PayPalRESTException

transactions

public static AgreementTransactions transactions(APIContext apiContext,
                                                 java.lang.String agreementId,
                                                 java.util.Date startDate,
                                                 java.util.Date endDate)
                                          throws PayPalRESTException

List transactions for a billing agreement by passing the ID of the agreement, as well as the start and end dates of the range of transactions to list, to the request URI.

Parameters:

apiContext - APIContext used for the API call.

agreementId - String

Returns:

AgreementTransactions

Throws:

PayPalRESTException

getId

public java.lang.String getId()

Identifier of the agreement.

getState

public java.lang.String getState()

State of the agreement

getName

public java.lang.String getName()

Name of the agreement.

getDescription

public java.lang.String getDescription()

Description of the agreement.

getStartDate

public java.lang.String getStartDate()

Start date of the agreement. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).

getAgreementDetails

public AgreementDetails getAgreementDetails()

Details of the agreement.

getPayer

public Payer getPayer()

Details of the buyer who is enrolling in this agreement. This information is gathered from execution of the approval URL.

getShippingAddress

public Address getShippingAddress()

Shipping address object of the agreement, which should be provided if it is different from the default address.

getOverrideMerchantPreferences

public MerchantPreferences getOverrideMerchantPreferences()

Default merchant preferences from the billing plan are used, unless override preferences are provided here.

getOverrideChargeModels

public java.util.List<OverrideChargeModel> getOverrideChargeModels()

Array of override_charge_model for this agreement if needed to change the default models from the billing plan.

getPlan

public Plan getPlan()

Plan details for this agreement.

getCreateTime

public java.lang.String getCreateTime()

Date and time that this resource was created. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).

getUpdateTime

public java.lang.String getUpdateTime()

Date and time that this resource was updated. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).

getToken

public java.lang.String getToken()

Payment token

getLinks

public java.util.List<Links> getLinks()

setId

public Agreement setId(java.lang.String id)

Identifier of the agreement.

Returns:

this

setState

public Agreement setState(java.lang.String state)

State of the agreement

Returns:

this

setName

public Agreement setName(java.lang.String name)

Name of the agreement.

Returns:

this

setDescription

public Agreement setDescription(java.lang.String description)

Description of the agreement.

Returns:

this

setStartDate

public Agreement setStartDate(java.lang.String startDate)

Start date of the agreement. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).

Returns:

this

setAgreementDetails

public Agreement setAgreementDetails(AgreementDetails agreementDetails)

Details of the agreement.

Returns:

this

setPayer

public Agreement setPayer(Payer payer)

Details of the buyer who is enrolling in this agreement. This information is gathered from execution of the approval URL.

Returns:

this

setShippingAddress

public Agreement setShippingAddress(Address shippingAddress)

Shipping address object of the agreement, which should be provided if it is different from the default address.

Returns:

this

setOverrideMerchantPreferences

public Agreement setOverrideMerchantPreferences(MerchantPreferences overrideMerchantPreferences)

Default merchant preferences from the billing plan are used, unless override preferences are provided here.

Returns:

this

setOverrideChargeModels

public Agreement setOverrideChargeModels(java.util.List<OverrideChargeModel> overrideChargeModels)

Array of override_charge_model for this agreement if needed to change the default models from the billing plan.

Returns:

this

setPlan

public Agreement setPlan(Plan plan)

Plan details for this agreement.

Returns:

this

setCreateTime

public Agreement setCreateTime(java.lang.String createTime)

Date and time that this resource was created. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).

Returns:

this

setUpdateTime

public Agreement setUpdateTime(java.lang.String updateTime)

Date and time that this resource was updated. Date format yyyy-MM-dd z, as defined in [ISO8601](http://tools.ietf.org/html/rfc3339#section-5.6).

Returns:

this

setToken

public Agreement setToken(java.lang.String token)

Payment token

Returns:

this

setLinks

public Agreement 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