com.paypal.sdk.models

Class SubscriberRequest

java.lang.Object

com.paypal.sdk.models.SubscriberRequest

public class SubscriberRequest
extends Object

This is a model class for SubscriberRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SubscriberRequest() Default constructor.
SubscriberRequest(String emailAddress, String payerId, Name name, ShippingDetails shippingAddress, SubscriptionPaymentSource paymentSource, PhoneWithType phone) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getEmailAddress() Getter for EmailAddress.
Name	getName() Getter for Name.
String	getPayerId() Getter for PayerId.
SubscriptionPaymentSource	getPaymentSource() Getter for PaymentSource.
PhoneWithType	getPhone() Getter for Phone.
ShippingDetails	getShippingAddress() Getter for ShippingAddress.
void	setEmailAddress(String emailAddress) Setter for EmailAddress.
void	setName(Name name) Setter for Name.
void	setPayerId(String payerId) Setter for PayerId.
void	setPaymentSource(SubscriptionPaymentSource paymentSource) Setter for PaymentSource.
void	setPhone(PhoneWithType phone) Setter for Phone.
void	setShippingAddress(ShippingDetails shippingAddress) Setter for ShippingAddress.
SubscriberRequest.Builder	toBuilder() Builds a new SubscriberRequest.Builder object.
String	toString() Converts this SubscriberRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriberRequest

public SubscriberRequest()

Default constructor.

SubscriberRequest

public SubscriberRequest(String emailAddress,
                         String payerId,
                         Name name,
                         ShippingDetails shippingAddress,
                         SubscriptionPaymentSource paymentSource,
                         PhoneWithType phone)

Initialization constructor.

Parameters:

emailAddress - String value for emailAddress.

payerId - String value for payerId.

name - Name value for name.

shippingAddress - ShippingDetails value for shippingAddress.

paymentSource - SubscriptionPaymentSource value for paymentSource.

phone - PhoneWithType value for phone.

Method Detail

getEmailAddress

public String getEmailAddress()

Getter for EmailAddress. The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Returns:

Returns the String

setEmailAddress

public void setEmailAddress(String emailAddress)

Setter for EmailAddress. The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Parameters:

emailAddress - Value for String

getPayerId

public String getPayerId()

Getter for PayerId. The account identifier for a PayPal account.

Returns:

Returns the String

setPayerId

public void setPayerId(String payerId)

Setter for PayerId. The account identifier for a PayPal account.

Parameters:

payerId - Value for String

getName

public Name getName()

Getter for Name. The name of the party.

Returns:

Returns the Name

setName

public void setName(Name name)

Setter for Name. The name of the party.

Parameters:

name - Value for Name

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

getPaymentSource

public SubscriptionPaymentSource getPaymentSource()

Getter for PaymentSource. The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions.

Returns:

Returns the SubscriptionPaymentSource

setPaymentSource

public void setPaymentSource(SubscriptionPaymentSource paymentSource)

Setter for PaymentSource. The payment source definition. To be eligible to create subscription using debit or credit card, you will need to sign up here (https://www.paypal.com/bizsignup/entry/product/ppcp). Please note, its available only for non-3DS cards and for merchants in US and AU regions.

Parameters:

paymentSource - Value for SubscriptionPaymentSource

getPhone

public PhoneWithType getPhone()

Getter for Phone. The phone information.

Returns:

Returns the PhoneWithType

setPhone

public void setPhone(PhoneWithType phone)

Setter for Phone. The phone information.

Parameters:

phone - Value for PhoneWithType

toString

public String toString()

Converts this SubscriberRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SubscriberRequest.Builder toBuilder()

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

Returns:

a new SubscriberRequest.Builder object