Subscription (PayPal Server SDK 2.2.0 API)

java.lang.Object
- com.paypal.sdk.models.Subscription

```
public class Subscription
extends Object
```
This is a model class for Subscription type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Subscription.Builder
Class to build instances of Subscription.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Subscription.Builder` Class to build instances of `Subscription`.

Constructor Summary

Constructors
Constructor and Description
`Subscription()` Default constructor.
`Subscription(String id, String planId, String startTime, String quantity, Money shippingAmount, Subscriber subscriber, SubscriptionBillingInformation billingInfo, String createTime, String updateTime, String customId, Boolean planOverridden, PlanDetails plan, List<LinkDescription> links)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubscriptionBillingInformation`	`getBillingInfo()` Getter for BillingInfo.
`String`	`getCreateTime()` Getter for CreateTime.
`String`	`getCustomId()` Getter for CustomId.
`String`	`getId()` Getter for Id.
`List<LinkDescription>`	`getLinks()` Getter for Links.
`PlanDetails`	`getPlan()` Getter for Plan.
`String`	`getPlanId()` Getter for PlanId.
`Boolean`	`getPlanOverridden()` Getter for PlanOverridden.
`String`	`getQuantity()` Getter for Quantity.
`Money`	`getShippingAmount()` Getter for ShippingAmount.
`String`	`getStartTime()` Getter for StartTime.
`Subscriber`	`getSubscriber()` Getter for Subscriber.
`String`	`getUpdateTime()` Getter for UpdateTime.
`void`	`setBillingInfo(SubscriptionBillingInformation billingInfo)` Setter for BillingInfo.
`void`	`setCreateTime(String createTime)` Setter for CreateTime.
`void`	`setCustomId(String customId)` Setter for CustomId.
`void`	`setId(String id)` Setter for Id.
`void`	`setLinks(List<LinkDescription> links)` Setter for Links.
`void`	`setPlan(PlanDetails 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`	`setShippingAmount(Money shippingAmount)` Setter for ShippingAmount.
`void`	`setStartTime(String startTime)` Setter for StartTime.
`void`	`setSubscriber(Subscriber subscriber)` Setter for Subscriber.
`void`	`setUpdateTime(String updateTime)` Setter for UpdateTime.
`Subscription.Builder`	`toBuilder()` Builds a new `Subscription.Builder` object.
`String`	`toString()` Converts this Subscription into string format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Subscription
```
public Subscription()
```
    Default constructor.
  - Subscription
```
public Subscription(String id,
                    String planId,
                    String startTime,
                    String quantity,
                    Money shippingAmount,
                    Subscriber subscriber,
                    SubscriptionBillingInformation billingInfo,
                    String createTime,
                    String updateTime,
                    String customId,
                    Boolean planOverridden,
                    PlanDetails plan,
                    List<LinkDescription> links)
```
    Initialization constructor.
    
    Parameters:
    
    id - String value for id.
    
    planId - String value for planId.
    
    startTime - String value for startTime.
    
    quantity - String value for quantity.
    
    shippingAmount - Money value for shippingAmount.
    
    subscriber - Subscriber value for subscriber.
    
    billingInfo - SubscriptionBillingInformation value for billingInfo.
    
    createTime - String value for createTime.
    
    updateTime - String value for updateTime.
    
    customId - String value for customId.
    
    planOverridden - Boolean value for planOverridden.
    
    plan - PlanDetails value for plan.
    
    links - List of LinkDescription value for links.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. The PayPal-generated ID for the subscription.
    
    Returns:
    
    Returns the String
  - setId
```
public void setId(String id)
```
    Setter for Id. The PayPal-generated ID for the subscription.
    
    Parameters:
    
    id - Value for String
  - 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 Subscriber getSubscriber()
```
    Getter for Subscriber. The subscriber response information.
    
    Returns:
    
    Returns the Subscriber
  - setSubscriber
```
public void setSubscriber(Subscriber subscriber)
```
    Setter for Subscriber. The subscriber response information.
    
    Parameters:
    
    subscriber - Value for Subscriber
  - getBillingInfo
```
public SubscriptionBillingInformation getBillingInfo()
```
    Getter for BillingInfo. The billing details for the subscription. If the subscription was or is active, these fields are populated.
    
    Returns:
    
    Returns the SubscriptionBillingInformation
  - setBillingInfo
```
public void setBillingInfo(SubscriptionBillingInformation billingInfo)
```
    Setter for BillingInfo. The billing details for the subscription. If the subscription was or is active, these fields are populated.
    
    Parameters:
    
    billingInfo - Value for SubscriptionBillingInformation
  - getCreateTime
```
public String getCreateTime()
```
    Getter for CreateTime. 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
  - setCreateTime
```
public void setCreateTime(String createTime)
```
    Setter for CreateTime. 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:
    
    createTime - Value for String
  - getUpdateTime
```
public String getUpdateTime()
```
    Getter for UpdateTime. 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
  - setUpdateTime
```
public void setUpdateTime(String updateTime)
```
    Setter for UpdateTime. 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:
    
    updateTime - Value for String
  - 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
  - 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
  - getPlan
```
public PlanDetails getPlan()
```
    Getter for Plan. The plan details.
    
    Returns:
    
    Returns the PlanDetails
  - setPlan
```
public void setPlan(PlanDetails plan)
```
    Setter for Plan. The plan details.
    
    Parameters:
    
    plan - Value for PlanDetails
  - 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 Subscription into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public Subscription.Builder toBuilder()
```
    Builds a new Subscription.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new Subscription.Builder object

Class Subscription

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Subscription

Subscription

Method Detail

getId

setId

getPlanId

setPlanId

getStartTime

setStartTime

getQuantity

setQuantity

getShippingAmount

setShippingAmount

getSubscriber

setSubscriber

getBillingInfo

setBillingInfo

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getCustomId

setCustomId

getPlanOverridden

setPlanOverridden

getPlan

setPlan

getLinks

setLinks

toString

toBuilder