com.paypal.sdk.models

Class CreateSubscriptionInput

java.lang.Object

com.paypal.sdk.models.CreateSubscriptionInput

public class CreateSubscriptionInput
extends Object

This is a model class for CreateSubscriptionInput type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CreateSubscriptionInput() Default constructor.
CreateSubscriptionInput(String contentType, String prefer, String paypalRequestId, String paypalClientMetadataId, CreateSubscriptionRequest body) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
CreateSubscriptionRequest	getBody() Getter for Body.
String	getContentType() Getter for ContentType.
String	getPaypalClientMetadataId() Getter for PaypalClientMetadataId.
String	getPaypalRequestId() Getter for PaypalRequestId.
String	getPrefer() Getter for Prefer.
void	setBody(CreateSubscriptionRequest body) Setter for Body.
void	setPaypalClientMetadataId(String paypalClientMetadataId) Setter for PaypalClientMetadataId.
void	setPaypalRequestId(String paypalRequestId) Setter for PaypalRequestId.
void	setPrefer(String prefer) Setter for Prefer.
CreateSubscriptionInput.Builder	toBuilder() Builds a new CreateSubscriptionInput.Builder object.
String	toString() Converts this CreateSubscriptionInput into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSubscriptionInput

public CreateSubscriptionInput()

Default constructor.

CreateSubscriptionInput

public CreateSubscriptionInput(String contentType,
                               String prefer,
                               String paypalRequestId,
                               String paypalClientMetadataId,
                               CreateSubscriptionRequest body)

Initialization constructor.

Parameters:

contentType - String value for contentType.

prefer - String value for prefer.

paypalRequestId - String value for paypalRequestId.

paypalClientMetadataId - String value for paypalClientMetadataId.

body - CreateSubscriptionRequest value for body.

Method Detail

getContentType

public String getContentType()

Getter for ContentType.

Returns:

Returns the String

getPrefer

public String getPrefer()

Getter for Prefer. The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.

Returns:

Returns the String

setPrefer

public void setPrefer(String prefer)

Setter for Prefer. The preferred server response upon successful completion of the request. Value is: return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links. return=representation. The server returns a complete resource representation, including the current state of the resource.

Parameters:

prefer - Value for String

getPaypalRequestId

public String getPaypalRequestId()

Getter for PaypalRequestId. The server stores keys for 72 hours.

Returns:

Returns the String

setPaypalRequestId

public void setPaypalRequestId(String paypalRequestId)

Setter for PaypalRequestId. The server stores keys for 72 hours.

Parameters:

paypalRequestId - Value for String

getPaypalClientMetadataId

public String getPaypalClientMetadataId()

Getter for PaypalClientMetadataId. The PayPal Client Metadata Id(CMID) is used to provide device-specific information to PayPal's risk engine. This is crucial for transactions that require device-specific risk assessments. Merchants typically use the Paypal SDK that automatically submits the CMID or they use tools like Fraudnet JS for web or Magnes JS for mobile to generate the CMID on the frontend and then pass it to the API as part of the request headers.

Returns:

Returns the String

setPaypalClientMetadataId

public void setPaypalClientMetadataId(String paypalClientMetadataId)

Setter for PaypalClientMetadataId. The PayPal Client Metadata Id(CMID) is used to provide device-specific information to PayPal's risk engine. This is crucial for transactions that require device-specific risk assessments. Merchants typically use the Paypal SDK that automatically submits the CMID or they use tools like Fraudnet JS for web or Magnes JS for mobile to generate the CMID on the frontend and then pass it to the API as part of the request headers.

Parameters:

paypalClientMetadataId - Value for String

getBody

public CreateSubscriptionRequest getBody()

Getter for Body.

Returns:

Returns the CreateSubscriptionRequest

setBody

public void setBody(CreateSubscriptionRequest body)

Setter for Body.

Parameters:

body - Value for CreateSubscriptionRequest

toString

public String toString()

Converts this CreateSubscriptionInput into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CreateSubscriptionInput.Builder toBuilder()

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

Returns:

a new CreateSubscriptionInput.Builder object