java.lang.Object
- com.docusign.esign.model.AccountBillingPlan

All Implemented Interfaces:

Serializable
```
public class AccountBillingPlan
extends Object
implements Serializable
```
Contains information about an account billing plan..

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

AccountBillingPlan()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccountBillingPlan`	`addAddOnsItem(AddOn addOnsItem)`	addAddOnsItem.
`AccountBillingPlan`	`addOns(List<AddOn> addOns)`	addOns.
`AccountBillingPlan`	`addPlanFeatureSetsItem(FeatureSet planFeatureSetsItem)`	addPlanFeatureSetsItem.
`AccountBillingPlan`	`addSeatDiscountsItem(SeatDiscount seatDiscountsItem)`	addSeatDiscountsItem.
`AccountBillingPlan`	`appStoreReceiptExpirationDate(String appStoreReceiptExpirationDate)`	appStoreReceiptExpirationDate.
`AccountBillingPlan`	`appStoreReceiptPurchaseDate(String appStoreReceiptPurchaseDate)`	appStoreReceiptPurchaseDate.
`AccountBillingPlan`	`canCancelRenewal(String canCancelRenewal)`	canCancelRenewal.
`AccountBillingPlan`	`canUpgrade(String canUpgrade)`	canUpgrade.
`AccountBillingPlan`	`currencyCode(String currencyCode)`	currencyCode.
`AccountBillingPlan`	`downgradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)`	downgradePlanInformation.
`AccountBillingPlan`	`enableSupport(String enableSupport)`	enableSupport.
`boolean`	`equals(Object o)`	Compares objects.
`List<AddOn>`	`getAddOns()`	Reserved:.
`String`	`getAppStoreReceiptExpirationDate()`	.
`String`	`getAppStoreReceiptPurchaseDate()`	.
`String`	`getCanCancelRenewal()`	Reserved: TBD.
`String`	`getCanUpgrade()`	When set to true, specifies that you can upgrade the account through the API..
`String`	`getCurrencyCode()`	Specifies the ISO currency code for the account..
`DowngradePlanUpdateResponse`	`getDowngradePlanInformation()`	.
`String`	`getEnableSupport()`	When set to true, then customer support is provided as part of the account plan..
`String`	`getIncludedSeats()`	The number of seats (users) included..
`String`	`getIncrementalSeats()`	Reserved: TBD.
`String`	`getIsDowngrade()`	.
`String`	`getNotificationType()`	.
`String`	`getOtherDiscountPercent()`	Any other percentage discount for the plan.
`String`	`getPaymentCycle()`	.
`String`	`getPaymentMethod()`	The payment method used with the plan.
`String`	`getPerSeatPrice()`	.
`String`	`getPlanClassification()`	Identifies the type of plan.
`List<FeatureSet>`	`getPlanFeatureSets()`	A complex type that sets the feature sets for the account.
`String`	`getPlanId()`	.
`String`	`getPlanName()`	The name of the Billing Plan..
`String`	`getPlanStartDate()`	.
`String`	`getProductId()`	.
`String`	`getRenewalDate()`	.
`String`	`getRenewalStatus()`	The renewal status for the account.
`List<SeatDiscount>`	`getSeatDiscounts()`	A complex type that contains any seat discount information.
`String`	`getSubscriptionStartDate()`	.
`String`	`getSupportIncidentFee()`	The support incident fee charged for each support incident..
`String`	`getSupportPlanFee()`	The support plan fee charged for this plan..
`String`	`getTaxExemptId()`	.
`int`	`hashCode()`	Returns the HashCode.
`AccountBillingPlan`	`includedSeats(String includedSeats)`	includedSeats.
`AccountBillingPlan`	`incrementalSeats(String incrementalSeats)`	incrementalSeats.
`AccountBillingPlan`	`isDowngrade(String isDowngrade)`	isDowngrade.
`AccountBillingPlan`	`notificationType(String notificationType)`	notificationType.
`AccountBillingPlan`	`otherDiscountPercent(String otherDiscountPercent)`	otherDiscountPercent.
`AccountBillingPlan`	`paymentCycle(String paymentCycle)`	paymentCycle.
`AccountBillingPlan`	`paymentMethod(String paymentMethod)`	paymentMethod.
`AccountBillingPlan`	`perSeatPrice(String perSeatPrice)`	perSeatPrice.
`AccountBillingPlan`	`planClassification(String planClassification)`	planClassification.
`AccountBillingPlan`	`planFeatureSets(List<FeatureSet> planFeatureSets)`	planFeatureSets.
`AccountBillingPlan`	`planId(String planId)`	planId.
`AccountBillingPlan`	`planName(String planName)`	planName.
`AccountBillingPlan`	`planStartDate(String planStartDate)`	planStartDate.
`AccountBillingPlan`	`productId(String productId)`	productId.
`AccountBillingPlan`	`renewalDate(String renewalDate)`	renewalDate.
`AccountBillingPlan`	`renewalStatus(String renewalStatus)`	renewalStatus.
`AccountBillingPlan`	`seatDiscounts(List<SeatDiscount> seatDiscounts)`	seatDiscounts.
`void`	`setAddOns(List<AddOn> addOns)`	setAddOns.
`void`	`setAppStoreReceiptExpirationDate(String appStoreReceiptExpirationDate)`	setAppStoreReceiptExpirationDate.
`void`	`setAppStoreReceiptPurchaseDate(String appStoreReceiptPurchaseDate)`	setAppStoreReceiptPurchaseDate.
`void`	`setCanCancelRenewal(String canCancelRenewal)`	setCanCancelRenewal.
`void`	`setCanUpgrade(String canUpgrade)`	setCanUpgrade.
`void`	`setCurrencyCode(String currencyCode)`	setCurrencyCode.
`void`	`setDowngradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)`	setDowngradePlanInformation.
`void`	`setEnableSupport(String enableSupport)`	setEnableSupport.
`void`	`setIncludedSeats(String includedSeats)`	setIncludedSeats.
`void`	`setIncrementalSeats(String incrementalSeats)`	setIncrementalSeats.
`void`	`setIsDowngrade(String isDowngrade)`	setIsDowngrade.
`void`	`setNotificationType(String notificationType)`	setNotificationType.
`void`	`setOtherDiscountPercent(String otherDiscountPercent)`	setOtherDiscountPercent.
`void`	`setPaymentCycle(String paymentCycle)`	setPaymentCycle.
`void`	`setPaymentMethod(String paymentMethod)`	setPaymentMethod.
`void`	`setPerSeatPrice(String perSeatPrice)`	setPerSeatPrice.
`void`	`setPlanClassification(String planClassification)`	setPlanClassification.
`void`	`setPlanFeatureSets(List<FeatureSet> planFeatureSets)`	setPlanFeatureSets.
`void`	`setPlanId(String planId)`	setPlanId.
`void`	`setPlanName(String planName)`	setPlanName.
`void`	`setPlanStartDate(String planStartDate)`	setPlanStartDate.
`void`	`setProductId(String productId)`	setProductId.
`void`	`setRenewalDate(String renewalDate)`	setRenewalDate.
`void`	`setRenewalStatus(String renewalStatus)`	setRenewalStatus.
`void`	`setSeatDiscounts(List<SeatDiscount> seatDiscounts)`	setSeatDiscounts.
`void`	`setSubscriptionStartDate(String subscriptionStartDate)`	setSubscriptionStartDate.
`void`	`setSupportIncidentFee(String supportIncidentFee)`	setSupportIncidentFee.
`void`	`setSupportPlanFee(String supportPlanFee)`	setSupportPlanFee.
`void`	`setTaxExemptId(String taxExemptId)`	setTaxExemptId.
`AccountBillingPlan`	`subscriptionStartDate(String subscriptionStartDate)`	subscriptionStartDate.
`AccountBillingPlan`	`supportIncidentFee(String supportIncidentFee)`	supportIncidentFee.
`AccountBillingPlan`	`supportPlanFee(String supportPlanFee)`	supportPlanFee.
`AccountBillingPlan`	`taxExemptId(String taxExemptId)`	taxExemptId.
`String`	`toString()`	Converts the given object to string.

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

- Constructor Detail
  - AccountBillingPlan
```
public AccountBillingPlan()
```
- Method Detail
  - addOns
```
public AccountBillingPlan addOns(List<AddOn> addOns)
```
    addOns.
    
    Returns:
    
    AccountBillingPlan
  - addAddOnsItem
```
public AccountBillingPlan addAddOnsItem(AddOn addOnsItem)
```
    addAddOnsItem.
    
    Returns:
    
    AccountBillingPlan
  - getAddOns
```
public List<AddOn> getAddOns()
```
    Reserved:.
    
    Returns:
    
    addOns
  - setAddOns
```
public void setAddOns(List<AddOn> addOns)
```
    setAddOns.
  - appStoreReceiptExpirationDate
```
public AccountBillingPlan appStoreReceiptExpirationDate(String appStoreReceiptExpirationDate)
```
    appStoreReceiptExpirationDate.
    
    Returns:
    
    AccountBillingPlan
  - getAppStoreReceiptExpirationDate
```
public String getAppStoreReceiptExpirationDate()
```
    .
    
    Returns:
    
    appStoreReceiptExpirationDate
  - setAppStoreReceiptExpirationDate
```
public void setAppStoreReceiptExpirationDate(String appStoreReceiptExpirationDate)
```
    setAppStoreReceiptExpirationDate.
  - appStoreReceiptPurchaseDate
```
public AccountBillingPlan appStoreReceiptPurchaseDate(String appStoreReceiptPurchaseDate)
```
    appStoreReceiptPurchaseDate.
    
    Returns:
    
    AccountBillingPlan
  - getAppStoreReceiptPurchaseDate
```
public String getAppStoreReceiptPurchaseDate()
```
    .
    
    Returns:
    
    appStoreReceiptPurchaseDate
  - setAppStoreReceiptPurchaseDate
```
public void setAppStoreReceiptPurchaseDate(String appStoreReceiptPurchaseDate)
```
    setAppStoreReceiptPurchaseDate.
  - canCancelRenewal
```
public AccountBillingPlan canCancelRenewal(String canCancelRenewal)
```
    canCancelRenewal.
    
    Returns:
    
    AccountBillingPlan
  - getCanCancelRenewal
```
public String getCanCancelRenewal()
```
    Reserved: TBD.
    
    Returns:
    
    canCancelRenewal
  - setCanCancelRenewal
```
public void setCanCancelRenewal(String canCancelRenewal)
```
    setCanCancelRenewal.
  - canUpgrade
```
public AccountBillingPlan canUpgrade(String canUpgrade)
```
    canUpgrade.
    
    Returns:
    
    AccountBillingPlan
  - getCanUpgrade
```
public String getCanUpgrade()
```
    When set to **true**, specifies that you can upgrade the account through the API..
    
    Returns:
    
    canUpgrade
  - setCanUpgrade
```
public void setCanUpgrade(String canUpgrade)
```
    setCanUpgrade.
  - currencyCode
```
public AccountBillingPlan currencyCode(String currencyCode)
```
    currencyCode.
    
    Returns:
    
    AccountBillingPlan
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Specifies the ISO currency code for the account..
    
    Returns:
    
    currencyCode
  - setCurrencyCode
```
public void setCurrencyCode(String currencyCode)
```
    setCurrencyCode.
  - downgradePlanInformation
```
public AccountBillingPlan downgradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)
```
    downgradePlanInformation.
    
    Returns:
    
    AccountBillingPlan
  - getDowngradePlanInformation
```
public DowngradePlanUpdateResponse getDowngradePlanInformation()
```
    .
    
    Returns:
    
    downgradePlanInformation
  - setDowngradePlanInformation
```
public void setDowngradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)
```
    setDowngradePlanInformation.
  - enableSupport
```
public AccountBillingPlan enableSupport(String enableSupport)
```
    enableSupport.
    
    Returns:
    
    AccountBillingPlan
  - getEnableSupport
```
public String getEnableSupport()
```
    When set to **true**, then customer support is provided as part of the account plan..
    
    Returns:
    
    enableSupport
  - setEnableSupport
```
public void setEnableSupport(String enableSupport)
```
    setEnableSupport.
  - includedSeats
```
public AccountBillingPlan includedSeats(String includedSeats)
```
    includedSeats.
    
    Returns:
    
    AccountBillingPlan
  - getIncludedSeats
```
public String getIncludedSeats()
```
    The number of seats (users) included..
    
    Returns:
    
    includedSeats
  - setIncludedSeats
```
public void setIncludedSeats(String includedSeats)
```
    setIncludedSeats.
  - incrementalSeats
```
public AccountBillingPlan incrementalSeats(String incrementalSeats)
```
    incrementalSeats.
    
    Returns:
    
    AccountBillingPlan
  - getIncrementalSeats
```
public String getIncrementalSeats()
```
    Reserved: TBD.
    
    Returns:
    
    incrementalSeats
  - setIncrementalSeats
```
public void setIncrementalSeats(String incrementalSeats)
```
    setIncrementalSeats.
  - isDowngrade
```
public AccountBillingPlan isDowngrade(String isDowngrade)
```
    isDowngrade.
    
    Returns:
    
    AccountBillingPlan
  - getIsDowngrade
```
public String getIsDowngrade()
```
    .
    
    Returns:
    
    isDowngrade
  - setIsDowngrade
```
public void setIsDowngrade(String isDowngrade)
```
    setIsDowngrade.
  - notificationType
```
public AccountBillingPlan notificationType(String notificationType)
```
    notificationType.
    
    Returns:
    
    AccountBillingPlan
  - getNotificationType
```
public String getNotificationType()
```
    .
    
    Returns:
    
    notificationType
  - setNotificationType
```
public void setNotificationType(String notificationType)
```
    setNotificationType.
  - otherDiscountPercent
```
public AccountBillingPlan otherDiscountPercent(String otherDiscountPercent)
```
    otherDiscountPercent.
    
    Returns:
    
    AccountBillingPlan
  - getOtherDiscountPercent
```
public String getOtherDiscountPercent()
```
    Any other percentage discount for the plan. .
    
    Returns:
    
    otherDiscountPercent
  - setOtherDiscountPercent
```
public void setOtherDiscountPercent(String otherDiscountPercent)
```
    setOtherDiscountPercent.
  - paymentCycle
```
public AccountBillingPlan paymentCycle(String paymentCycle)
```
    paymentCycle.
    
    Returns:
    
    AccountBillingPlan
  - getPaymentCycle
```
public String getPaymentCycle()
```
    .
    
    Returns:
    
    paymentCycle
  - setPaymentCycle
```
public void setPaymentCycle(String paymentCycle)
```
    setPaymentCycle.
  - paymentMethod
```
public AccountBillingPlan paymentMethod(String paymentMethod)
```
    paymentMethod.
    
    Returns:
    
    AccountBillingPlan
  - getPaymentMethod
```
public String getPaymentMethod()
```
    The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. .
    
    Returns:
    
    paymentMethod
  - setPaymentMethod
```
public void setPaymentMethod(String paymentMethod)
```
    setPaymentMethod.
  - perSeatPrice
```
public AccountBillingPlan perSeatPrice(String perSeatPrice)
```
    perSeatPrice.
    
    Returns:
    
    AccountBillingPlan
  - getPerSeatPrice
```
public String getPerSeatPrice()
```
    .
    
    Returns:
    
    perSeatPrice
  - setPerSeatPrice
```
public void setPerSeatPrice(String perSeatPrice)
```
    setPerSeatPrice.
  - planClassification
```
public AccountBillingPlan planClassification(String planClassification)
```
    planClassification.
    
    Returns:
    
    AccountBillingPlan
  - getPlanClassification
```
public String getPlanClassification()
```
    Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free..
    
    Returns:
    
    planClassification
  - setPlanClassification
```
public void setPlanClassification(String planClassification)
```
    setPlanClassification.
  - planFeatureSets
```
public AccountBillingPlan planFeatureSets(List<FeatureSet> planFeatureSets)
```
    planFeatureSets.
    
    Returns:
    
    AccountBillingPlan
  - addPlanFeatureSetsItem
```
public AccountBillingPlan addPlanFeatureSetsItem(FeatureSet planFeatureSetsItem)
```
    addPlanFeatureSetsItem.
    
    Returns:
    
    AccountBillingPlan
  - getPlanFeatureSets
```
public List<FeatureSet> getPlanFeatureSets()
```
    A complex type that sets the feature sets for the account. It contains the following information (all string content): * currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set. * envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true). * featureSetId - A unique ID for the feature set. * fixedFee - A one-time fee associated with the plan (when isEnabled=true). * isActive - Specifies whether the feature set is actively set as part of the plan. * isEnabled - Specifies whether the feature set is actively enabled as part of the plan. * name - The name of the feature set. * seatFee - An incremental seat cost for seat-based plans (when isEnabled=true). .
    
    Returns:
    
    planFeatureSets
  - setPlanFeatureSets
```
public void setPlanFeatureSets(List<FeatureSet> planFeatureSets)
```
    setPlanFeatureSets.
  - planId
```
public AccountBillingPlan planId(String planId)
```
    planId.
    
    Returns:
    
    AccountBillingPlan
  - getPlanId
```
public String getPlanId()
```
    .
    
    Returns:
    
    planId
  - setPlanId
```
public void setPlanId(String planId)
```
    setPlanId.
  - planName
```
public AccountBillingPlan planName(String planName)
```
    planName.
    
    Returns:
    
    AccountBillingPlan
  - getPlanName
```
public String getPlanName()
```
    The name of the Billing Plan..
    
    Returns:
    
    planName
  - setPlanName
```
public void setPlanName(String planName)
```
    setPlanName.
  - planStartDate
```
public AccountBillingPlan planStartDate(String planStartDate)
```
    planStartDate.
    
    Returns:
    
    AccountBillingPlan
  - getPlanStartDate
```
public String getPlanStartDate()
```
    .
    
    Returns:
    
    planStartDate
  - setPlanStartDate
```
public void setPlanStartDate(String planStartDate)
```
    setPlanStartDate.
  - productId
```
public AccountBillingPlan productId(String productId)
```
    productId.
    
    Returns:
    
    AccountBillingPlan
  - getProductId
```
public String getProductId()
```
    .
    
    Returns:
    
    productId
  - setProductId
```
public void setProductId(String productId)
```
    setProductId.
  - renewalDate
```
public AccountBillingPlan renewalDate(String renewalDate)
```
    renewalDate.
    
    Returns:
    
    AccountBillingPlan
  - getRenewalDate
```
public String getRenewalDate()
```
    .
    
    Returns:
    
    renewalDate
  - setRenewalDate
```
public void setRenewalDate(String renewalDate)
```
    setRenewalDate.
  - renewalStatus
```
public AccountBillingPlan renewalStatus(String renewalStatus)
```
    renewalStatus.
    
    Returns:
    
    AccountBillingPlan
  - getRenewalStatus
```
public String getRenewalStatus()
```
    The renewal status for the account. The acceptable values are: * auto: The account automatically renews. * queued_for_close: Account will be closed at the billingPeriodEndDate. * queued_for_downgrade: Account will be downgraded at the billingPeriodEndDate..
    
    Returns:
    
    renewalStatus
  - setRenewalStatus
```
public void setRenewalStatus(String renewalStatus)
```
    setRenewalStatus.
  - seatDiscounts
```
public AccountBillingPlan seatDiscounts(List<SeatDiscount> seatDiscounts)
```
    seatDiscounts.
    
    Returns:
    
    AccountBillingPlan
  - addSeatDiscountsItem
```
public AccountBillingPlan addSeatDiscountsItem(SeatDiscount seatDiscountsItem)
```
    addSeatDiscountsItem.
    
    Returns:
    
    AccountBillingPlan
  - getSeatDiscounts
```
public List<SeatDiscount> getSeatDiscounts()
```
    A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. .
    
    Returns:
    
    seatDiscounts
  - setSeatDiscounts
```
public void setSeatDiscounts(List<SeatDiscount> seatDiscounts)
```
    setSeatDiscounts.
  - subscriptionStartDate
```
public AccountBillingPlan subscriptionStartDate(String subscriptionStartDate)
```
    subscriptionStartDate.
    
    Returns:
    
    AccountBillingPlan
  - getSubscriptionStartDate
```
public String getSubscriptionStartDate()
```
    .
    
    Returns:
    
    subscriptionStartDate
  - setSubscriptionStartDate
```
public void setSubscriptionStartDate(String subscriptionStartDate)
```
    setSubscriptionStartDate.
  - supportIncidentFee
```
public AccountBillingPlan supportIncidentFee(String supportIncidentFee)
```
    supportIncidentFee.
    
    Returns:
    
    AccountBillingPlan
  - getSupportIncidentFee
```
public String getSupportIncidentFee()
```
    The support incident fee charged for each support incident..
    
    Returns:
    
    supportIncidentFee
  - setSupportIncidentFee
```
public void setSupportIncidentFee(String supportIncidentFee)
```
    setSupportIncidentFee.
  - supportPlanFee
```
public AccountBillingPlan supportPlanFee(String supportPlanFee)
```
    supportPlanFee.
    
    Returns:
    
    AccountBillingPlan
  - getSupportPlanFee
```
public String getSupportPlanFee()
```
    The support plan fee charged for this plan..
    
    Returns:
    
    supportPlanFee
  - setSupportPlanFee
```
public void setSupportPlanFee(String supportPlanFee)
```
    setSupportPlanFee.
  - taxExemptId
```
public AccountBillingPlan taxExemptId(String taxExemptId)
```
    taxExemptId.
    
    Returns:
    
    AccountBillingPlan
  - getTaxExemptId
```
public String getTaxExemptId()
```
    .
    
    Returns:
    
    taxExemptId
  - setTaxExemptId
```
public void setTaxExemptId(String taxExemptId)
```
    setTaxExemptId.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class AccountBillingPlan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccountBillingPlan

Method Detail

addOns

addAddOnsItem

getAddOns

setAddOns

appStoreReceiptExpirationDate

getAppStoreReceiptExpirationDate

setAppStoreReceiptExpirationDate

appStoreReceiptPurchaseDate

getAppStoreReceiptPurchaseDate

setAppStoreReceiptPurchaseDate

canCancelRenewal

getCanCancelRenewal

setCanCancelRenewal

canUpgrade

getCanUpgrade

setCanUpgrade

currencyCode

getCurrencyCode

setCurrencyCode

downgradePlanInformation

getDowngradePlanInformation

setDowngradePlanInformation

enableSupport

getEnableSupport

setEnableSupport

includedSeats

getIncludedSeats

setIncludedSeats

incrementalSeats

getIncrementalSeats

setIncrementalSeats

isDowngrade

getIsDowngrade

setIsDowngrade

notificationType

getNotificationType

setNotificationType

otherDiscountPercent

getOtherDiscountPercent

setOtherDiscountPercent

paymentCycle

getPaymentCycle

setPaymentCycle

paymentMethod

getPaymentMethod

setPaymentMethod

perSeatPrice

getPerSeatPrice

setPerSeatPrice

planClassification

getPlanClassification

setPlanClassification

planFeatureSets

addPlanFeatureSetsItem

getPlanFeatureSets

setPlanFeatureSets

planId

getPlanId

setPlanId

planName

getPlanName

setPlanName

planStartDate

getPlanStartDate

setPlanStartDate

productId

getProductId

setProductId

renewalDate

getRenewalDate

setRenewalDate

renewalStatus

getRenewalStatus