com.paypal.sdk.models

Class CreateSubscriptionRequest

java.lang.Object

com.paypal.sdk.models.CreateSubscriptionRequest

public class CreateSubscriptionRequest
extends Object

This is a model class for CreateSubscriptionRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateSubscriptionRequest() Default constructor.
CreateSubscriptionRequest(String planId, String startTime, String quantity, Money shippingAmount, SubscriberRequest subscriber, Boolean autoRenewal, SubscriptionApplicationContext applicationContext, String customId, PlanOverride plan) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
SubscriptionApplicationContext	getApplicationContext() Getter for ApplicationContext.
Boolean	getAutoRenewal() Getter for AutoRenewal.
String	getCustomId() Getter for CustomId.
PlanOverride	getPlan() Getter for Plan.
String	getPlanId() Getter for PlanId.
String	getQuantity() Getter for Quantity.
Money	getShippingAmount() Getter for ShippingAmount.
String	getStartTime() Getter for StartTime.
SubscriberRequest	getSubscriber() Getter for Subscriber.
void	setApplicationContext(SubscriptionApplicationContext applicationContext) Setter for ApplicationContext.
void	setAutoRenewal(Boolean autoRenewal) Setter for AutoRenewal.
void	setCustomId(String customId) Setter for CustomId.
void	setPlan(PlanOverride plan) Setter for Plan.
void	setPlanId(String planId) Setter for PlanId.
void	setQuantity(String quantity) Setter for Quantity.
void	setShippingAmount(Money shippingAmount) Setter for ShippingAmount.
void	setStartTime(String startTime) Setter for StartTime.
void	setSubscriber(SubscriberRequest subscriber) Setter for Subscriber.
CreateSubscriptionRequest.Builder	toBuilder() Builds a new CreateSubscriptionRequest.Builder object.
String	toString() Converts this CreateSubscriptionRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSubscriptionRequest

public CreateSubscriptionRequest()

Default constructor.

CreateSubscriptionRequest

public CreateSubscriptionRequest(String planId,
                                 String startTime,
                                 String quantity,
                                 Money shippingAmount,
                                 SubscriberRequest subscriber,
                                 Boolean autoRenewal,
                                 SubscriptionApplicationContext applicationContext,
                                 String customId,
                                 PlanOverride plan)

Initialization constructor.

Parameters:

planId - String value for planId.

startTime - String value for startTime.

quantity - String value for quantity.

shippingAmount - Money value for shippingAmount.

subscriber - SubscriberRequest value for subscriber.

autoRenewal - Boolean value for autoRenewal.

applicationContext - SubscriptionApplicationContext value for applicationContext.

customId - String value for customId.

plan - PlanOverride value for plan.

Method Detail

getPlanId

public String getPlanId()

Getter for PlanId. The ID of the plan.

Returns:

Returns the String

setPlanId

public void setPlanId(String planId)

Setter for PlanId. The ID of the plan.

Parameters:

planId - Value for String

getStartTime

public String getStartTime()

Getter for StartTime. 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

setStartTime

public void setStartTime(String startTime)

Setter for StartTime. 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:

startTime - Value for String

getQuantity

public String getQuantity()

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

Returns:

Returns the String

setQuantity

public void setQuantity(String quantity)

Setter for Quantity. The quantity of the product 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

getSubscriber

public SubscriberRequest getSubscriber()

Getter for Subscriber. The subscriber request information .

Returns:

Returns the SubscriberRequest

setSubscriber

public void setSubscriber(SubscriberRequest subscriber)

Setter for Subscriber. The subscriber request information .

Parameters:

subscriber - Value for SubscriberRequest

getAutoRenewal

public Boolean getAutoRenewal()

Getter for AutoRenewal. DEPRECATED. Indicates whether the subscription auto-renews after the billing cycles complete.

Returns:

Returns the Boolean

setAutoRenewal

public void setAutoRenewal(Boolean autoRenewal)

Setter for AutoRenewal. DEPRECATED. Indicates whether the subscription auto-renews after the billing cycles complete.

Parameters:

autoRenewal - Value for Boolean

getApplicationContext

public SubscriptionApplicationContext getApplicationContext()

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

Returns:

Returns the SubscriptionApplicationContext

setApplicationContext

public void setApplicationContext(SubscriptionApplicationContext applicationContext)

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

Parameters:

applicationContext - Value for SubscriptionApplicationContext

getCustomId

public String getCustomId()

Getter for CustomId. The custom id for the subscription. Can be invoice id.

Returns:

Returns the String

setCustomId

public void setCustomId(String customId)

Setter for CustomId. The custom id for the subscription. Can be invoice id.

Parameters:

customId - Value for String

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateSubscriptionRequest.Builder toBuilder()

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

Returns:

a new CreateSubscriptionRequest.Builder object