Subscription (Braintree Gateway Java Client Library 2.84.0 API)

java.lang.Object
- com.braintreegateway.Subscription

public class Subscription
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Subscription.DurationUnit

static class Subscription.Source

static class Subscription.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`Subscription.DurationUnit`
`static class`	`Subscription.Source`
`static class`	`Subscription.Status`

Field Summary

Fields
Modifier and Type	Field and Description
`private ArrayList<AddOn>`	`addOns`
`private BigDecimal`	`balance`
`private Integer`	`billingDayOfMonth`
`private Calendar`	`billingPeriodEndDate`
`private Calendar`	`billingPeriodStartDate`
`private Calendar`	`createdAt`
`private Integer`	`currentBillingCycle`
`private Integer`	`daysPastDue`
`private String`	`description`
`private Descriptor`	`descriptor`
`private ArrayList<Discount>`	`discounts`
`private Integer`	`failureCount`
`private Calendar`	`firstBillingDate`
`private Boolean`	`hasTrialPeriod`
`private String`	`id`
`private String`	`merchantAccountId`
`private boolean`	`neverExpires`
`private BigDecimal`	`nextBillAmount`
`private Calendar`	`nextBillingDate`
`private BigDecimal`	`nextBillingPeriodAmount`
`private Integer`	`numberOfBillingCycles`
`private Calendar`	`paidThroughDate`
`private String`	`paymentMethodToken`
`private String`	`planId`
`private BigDecimal`	`price`
`private Subscription.Status`	`status`
`private List<SubscriptionStatusEvent>`	`statusHistory`
`private List<Transaction>`	`transactions`
`private Integer`	`trialDuration`
`private Subscription.DurationUnit`	`trialDurationUnit`
`private Calendar`	`updatedAt`

Constructor Summary

Constructors
Constructor and Description

Subscription(NodeWrapper node)

Constructors
Constructor and Description
`Subscription(NodeWrapper node)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`List<AddOn>`	`getAddOns()`
`BigDecimal`	`getBalance()`
`Integer`	`getBillingDayOfMonth()`
`Calendar`	`getBillingPeriodEndDate()`
`Calendar`	`getBillingPeriodStartDate()`
`Calendar`	`getCreatedAt()`
`Integer`	`getCurrentBillingCycle()`
`Integer`	`getDaysPastDue()`
`String`	`getDescription()`
`Descriptor`	`getDescriptor()`
`List<Discount>`	`getDiscounts()`
`Integer`	`getFailureCount()`
`Calendar`	`getFirstBillingDate()`
`String`	`getId()`
`String`	`getMerchantAccountId()`
`BigDecimal`	`getNextBillAmount()` Deprecated.
`Calendar`	`getNextBillingDate()`
`BigDecimal`	`getNextBillingPeriodAmount()`
`Integer`	`getNumberOfBillingCycles()`
`Calendar`	`getPaidThroughDate()`
`String`	`getPaymentMethodToken()`
`String`	`getPlanId()`
`BigDecimal`	`getPrice()`
`Subscription.Status`	`getStatus()`
`List<SubscriptionStatusEvent>`	`getStatusHistory()`
`List<Transaction>`	`getTransactions()`
`Integer`	`getTrialDuration()`
`Subscription.DurationUnit`	`getTrialDurationUnit()`
`Calendar`	`getUpdatedAt()`
`Boolean`	`hasTrialPeriod()`
`boolean`	`neverExpires()`

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

Field Detail

addOns
```
private ArrayList<AddOn> addOns
```

balance
```
private BigDecimal balance
```

billingDayOfMonth
```
private Integer billingDayOfMonth
```

billingPeriodEndDate
```
private Calendar billingPeriodEndDate
```

billingPeriodStartDate

private Calendar billingPeriodStartDate

currentBillingCycle
```
private Integer currentBillingCycle
```

daysPastDue
```
private Integer daysPastDue
```

descriptor
```
private Descriptor descriptor
```

description
```
private String description
```

discounts
```
private ArrayList<Discount> discounts
```

failureCount
```
private Integer failureCount
```

createdAt
```
private Calendar createdAt
```

updatedAt
```
private Calendar updatedAt
```

firstBillingDate
```
private Calendar firstBillingDate
```

hasTrialPeriod
```
private Boolean hasTrialPeriod
```

id
```
private String id
```

merchantAccountId
```
private String merchantAccountId
```

neverExpires
```
private boolean neverExpires
```

nextBillAmount
```
private BigDecimal nextBillAmount
```

nextBillingDate
```
private Calendar nextBillingDate
```

nextBillingPeriodAmount

private BigDecimal nextBillingPeriodAmount

numberOfBillingCycles
```
private Integer numberOfBillingCycles
```

paidThroughDate
```
private Calendar paidThroughDate
```

paymentMethodToken
```
private String paymentMethodToken
```

planId
```
private String planId
```

price
```
private BigDecimal price
```

status
```
private Subscription.Status status
```

statusHistory

private List<SubscriptionStatusEvent> statusHistory

transactions
```
private List<Transaction> transactions
```

trialDuration
```
private Integer trialDuration
```

trialDurationUnit

private Subscription.DurationUnit trialDurationUnit

Constructor Detail
- Subscription
```
public Subscription(NodeWrapper node)
```

Method Detail

getAddOns
```
public List<AddOn> getAddOns()
```

getBalance
```
public BigDecimal getBalance()
```

getBillingDayOfMonth
```
public Integer getBillingDayOfMonth()
```

getBillingPeriodEndDate

public Calendar getBillingPeriodEndDate()

getBillingPeriodStartDate

public Calendar getBillingPeriodStartDate()

getCurrentBillingCycle

public Integer getCurrentBillingCycle()

getDaysPastDue
```
public Integer getDaysPastDue()
```

getDescriptor
```
public Descriptor getDescriptor()
```

getDescription
```
public String getDescription()
```

getDiscounts
```
public List<Discount> getDiscounts()
```

getFailureCount
```
public Integer getFailureCount()
```

getFirstBillingDate
```
public Calendar getFirstBillingDate()
```

getId
```
public String getId()
```

getMerchantAccountId
```
public String getMerchantAccountId()
```

getNextBillAmount

@Deprecated
public BigDecimal getNextBillAmount()

Deprecated.

getNextBillingDate
```
public Calendar getNextBillingDate()
```

getNextBillingPeriodAmount

public BigDecimal getNextBillingPeriodAmount()

getNumberOfBillingCycles

public Integer getNumberOfBillingCycles()

getCreatedAt
```
public Calendar getCreatedAt()
```

getUpdatedAt
```
public Calendar getUpdatedAt()
```

getPaidThroughDate
```
public Calendar getPaidThroughDate()
```

getPaymentMethodToken
```
public String getPaymentMethodToken()
```

getPlanId
```
public String getPlanId()
```

getPrice
```
public BigDecimal getPrice()
```

getStatusHistory

public List<SubscriptionStatusEvent> getStatusHistory()

getStatus

public Subscription.Status getStatus()

getTransactions

public List<Transaction> getTransactions()

getTrialDuration
```
public Integer getTrialDuration()
```

getTrialDurationUnit

public Subscription.DurationUnit getTrialDurationUnit()

hasTrialPeriod
```
public Boolean hasTrialPeriod()
```

neverExpires
```
public boolean neverExpires()
```

equals
```
public boolean equals(Object other)
```
Overrides:

equals in class Object

Class Subscription

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

addOns

balance

billingDayOfMonth

billingPeriodEndDate

billingPeriodStartDate

currentBillingCycle

daysPastDue

descriptor

description

discounts

failureCount

createdAt

updatedAt

firstBillingDate

hasTrialPeriod

id

merchantAccountId

neverExpires

nextBillAmount

nextBillingDate

nextBillingPeriodAmount

numberOfBillingCycles

paidThroughDate

paymentMethodToken

planId

price

status

statusHistory

transactions

trialDuration

trialDurationUnit

Constructor Detail

Subscription

Method Detail

getAddOns

getBalance

getBillingDayOfMonth

getBillingPeriodEndDate

getBillingPeriodStartDate

getCurrentBillingCycle

getDaysPastDue

getDescriptor

getDescription

getDiscounts

getFailureCount

getFirstBillingDate

getId

getMerchantAccountId

getNextBillAmount

getNextBillingDate

getNextBillingPeriodAmount

getNumberOfBillingCycles

getCreatedAt

getUpdatedAt

getPaidThroughDate

getPaymentMethodToken

getPlanId

getPrice

getStatusHistory

getStatus

getTransactions

getTrialDuration

getTrialDurationUnit

hasTrialPeriod

neverExpires

equals