com.paypal.sdk.models

Class ModifySubscriptionRequest

java.lang.Object

com.paypal.sdk.models.ModifySubscriptionRequest

public class ModifySubscriptionRequest
extends Object

This is a model class for ModifySubscriptionRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModifySubscriptionRequest() Default constructor.
ModifySubscriptionRequest(String planId, String quantity, Money shippingAmount, ShippingDetails shippingAddress, SubscriptionPatchApplicationContext applicationContext, PlanOverride plan) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
SubscriptionPatchApplicationContext	getApplicationContext() Getter for ApplicationContext.
PlanOverride	getPlan() Getter for Plan.
String	getPlanId() Getter for PlanId.
String	getQuantity() Getter for Quantity.
ShippingDetails	getShippingAddress() Getter for ShippingAddress.
Money	getShippingAmount() Getter for ShippingAmount.
void	setApplicationContext(SubscriptionPatchApplicationContext applicationContext) Setter for ApplicationContext.
void	setPlan(PlanOverride plan) Setter for Plan.
void	setPlanId(String planId) Setter for PlanId.
void	setQuantity(String quantity) Setter for Quantity.
void	setShippingAddress(ShippingDetails shippingAddress) Setter for ShippingAddress.
void	setShippingAmount(Money shippingAmount) Setter for ShippingAmount.
ModifySubscriptionRequest.Builder	toBuilder() Builds a new ModifySubscriptionRequest.Builder object.
String	toString() Converts this ModifySubscriptionRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifySubscriptionRequest

public ModifySubscriptionRequest()

Default constructor.

ModifySubscriptionRequest

public ModifySubscriptionRequest(String planId,
                                 String quantity,
                                 Money shippingAmount,
                                 ShippingDetails shippingAddress,
                                 SubscriptionPatchApplicationContext applicationContext,
                                 PlanOverride plan)

Initialization constructor.

Parameters:

planId - String value for planId.

quantity - String value for quantity.

shippingAmount - Money value for shippingAmount.

shippingAddress - ShippingDetails value for shippingAddress.

applicationContext - SubscriptionPatchApplicationContext value for applicationContext.

plan - PlanOverride value for plan.

Method Detail

getPlanId

public String getPlanId()

Getter for PlanId. The unique PayPal-generated ID for the plan.

Returns:

Returns the String

setPlanId

public void setPlanId(String planId)

Setter for PlanId. The unique PayPal-generated ID for the plan.

Parameters:

planId - Value for String

getQuantity

public String getQuantity()

Getter for Quantity. The quantity of the product or service in the subscription.

Returns:

Returns the String

setQuantity

public void setQuantity(String quantity)

Setter for Quantity. The quantity of the product or service in the subscription.

Parameters:

quantity - Value for String

getShippingAmount

public Money getShippingAmount()

Getter for ShippingAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Returns:

Returns the Money

setShippingAmount

public void setShippingAmount(Money shippingAmount)

Setter for ShippingAmount. The currency and amount for a financial transaction, such as a balance or payment due.

Parameters:

shippingAmount - Value for Money

getShippingAddress

public ShippingDetails getShippingAddress()

Getter for ShippingAddress. The shipping details.

Returns:

Returns the ShippingDetails

setShippingAddress

public void setShippingAddress(ShippingDetails shippingAddress)

Setter for ShippingAddress. The shipping details.

Parameters:

shippingAddress - Value for ShippingDetails

getApplicationContext

public SubscriptionPatchApplicationContext getApplicationContext()

Getter for ApplicationContext. The application context, which customizes the payer experience during the subscription approval process with PayPal.

Returns:

Returns the SubscriptionPatchApplicationContext

setApplicationContext

public void setApplicationContext(SubscriptionPatchApplicationContext applicationContext)

Setter for ApplicationContext. The application context, which customizes the payer experience during the subscription approval process with PayPal.

Parameters:

applicationContext - Value for SubscriptionPatchApplicationContext

getPlan

public PlanOverride getPlan()

Getter for Plan. An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object.

Returns:

Returns the PlanOverride

setPlan

public void setPlan(PlanOverride plan)

Setter for Plan. An inline plan object to customise the subscription. You can override plan level default attributes by providing customised values for the subscription in this object.

Parameters:

plan - Value for PlanOverride

toString

public String toString()

Converts this ModifySubscriptionRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ModifySubscriptionRequest.Builder toBuilder()

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

Returns:

a new ModifySubscriptionRequest.Builder object