com.paypal.sdk.models

Class ModifySubscriptionResponse

java.lang.Object

com.paypal.sdk.models.ModifySubscriptionResponse

public class ModifySubscriptionResponse
extends Object

This is a model class for ModifySubscriptionResponse type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModifySubscriptionResponse() Default constructor.
ModifySubscriptionResponse(String planId, String quantity, Money shippingAmount, ShippingDetails shippingAddress, PlanOverride plan, Boolean planOverridden, List<LinkDescription> links) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
List<LinkDescription>	getLinks() Getter for Links.
PlanOverride	getPlan() Getter for Plan.
String	getPlanId() Getter for PlanId.
Boolean	getPlanOverridden() Getter for PlanOverridden.
String	getQuantity() Getter for Quantity.
ShippingDetails	getShippingAddress() Getter for ShippingAddress.
Money	getShippingAmount() Getter for ShippingAmount.
void	setLinks(List<LinkDescription> links) Setter for Links.
void	setPlan(PlanOverride plan) Setter for Plan.
void	setPlanId(String planId) Setter for PlanId.
void	setPlanOverridden(Boolean planOverridden) Setter for PlanOverridden.
void	setQuantity(String quantity) Setter for Quantity.
void	setShippingAddress(ShippingDetails shippingAddress) Setter for ShippingAddress.
void	setShippingAmount(Money shippingAmount) Setter for ShippingAmount.
ModifySubscriptionResponse.Builder	toBuilder() Builds a new ModifySubscriptionResponse.Builder object.
String	toString() Converts this ModifySubscriptionResponse into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifySubscriptionResponse

public ModifySubscriptionResponse()

Default constructor.

ModifySubscriptionResponse

public ModifySubscriptionResponse(String planId,
                                  String quantity,
                                  Money shippingAmount,
                                  ShippingDetails shippingAddress,
                                  PlanOverride plan,
                                  Boolean planOverridden,
                                  List<LinkDescription> links)

Initialization constructor.

Parameters:

planId - String value for planId.

quantity - String value for quantity.

shippingAmount - Money value for shippingAmount.

shippingAddress - ShippingDetails value for shippingAddress.

plan - PlanOverride value for plan.

planOverridden - Boolean value for planOverridden.

links - List of LinkDescription value for links.

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

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

getPlanOverridden

public Boolean getPlanOverridden()

Getter for PlanOverridden. Indicates whether the subscription has overridden any plan attributes.

Returns:

Returns the Boolean

setPlanOverridden

public void setPlanOverridden(Boolean planOverridden)

Setter for PlanOverridden. Indicates whether the subscription has overridden any plan attributes.

Parameters:

planOverridden - Value for Boolean

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 ModifySubscriptionResponse into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ModifySubscriptionResponse.Builder toBuilder()

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

Returns:

a new ModifySubscriptionResponse.Builder object