com.docusign.esign.model

Class AccountBillingPlan

java.lang.Object

com.docusign.esign.model.AccountBillingPlan

public class AccountBillingPlan
extends Object

Contains information about an account billing plan.

Constructor Summary

Constructors

Constructor and Description
AccountBillingPlan()

Method Summary

Modifier and Type	Method and Description
AccountBillingPlan	addAddOnsItem(AddOn addOnsItem)
AccountBillingPlan	addOns(List<AddOn> addOns)
AccountBillingPlan	addPlanFeatureSetsItem(FeatureSet planFeatureSetsItem)
AccountBillingPlan	addSeatDiscountsItem(SeatDiscount seatDiscountsItem)
AccountBillingPlan	canCancelRenewal(String canCancelRenewal)
AccountBillingPlan	canUpgrade(String canUpgrade)
AccountBillingPlan	currencyCode(String currencyCode)
AccountBillingPlan	downgradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)
AccountBillingPlan	enableSupport(String enableSupport)
boolean	equals(Object o)
List<AddOn>	getAddOns() Reserved:
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() Get downgradePlanInformation
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	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	getRenewalStatus() The renewal status for the account.
List<SeatDiscount>	getSeatDiscounts() A complex type that contains any seat discount information.
String	getSupportIncidentFee() The support incident fee charged for each support incident.
String	getSupportPlanFee() The support plan fee charged for this plan.
int	hashCode()
AccountBillingPlan	includedSeats(String includedSeats)
AccountBillingPlan	incrementalSeats(String incrementalSeats)
AccountBillingPlan	isDowngrade(String isDowngrade)
AccountBillingPlan	otherDiscountPercent(String otherDiscountPercent)
AccountBillingPlan	paymentCycle(String paymentCycle)
AccountBillingPlan	paymentMethod(String paymentMethod)
AccountBillingPlan	perSeatPrice(String perSeatPrice)
AccountBillingPlan	planClassification(String planClassification)
AccountBillingPlan	planFeatureSets(List<FeatureSet> planFeatureSets)
AccountBillingPlan	planId(String planId)
AccountBillingPlan	planName(String planName)
AccountBillingPlan	renewalStatus(String renewalStatus)
AccountBillingPlan	seatDiscounts(List<SeatDiscount> seatDiscounts)
void	setAddOns(List<AddOn> addOns)
void	setCanCancelRenewal(String canCancelRenewal)
void	setCanUpgrade(String canUpgrade)
void	setCurrencyCode(String currencyCode)
void	setDowngradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)
void	setEnableSupport(String enableSupport)
void	setIncludedSeats(String includedSeats)
void	setIncrementalSeats(String incrementalSeats)
void	setIsDowngrade(String isDowngrade)
void	setOtherDiscountPercent(String otherDiscountPercent)
void	setPaymentCycle(String paymentCycle)
void	setPaymentMethod(String paymentMethod)
void	setPerSeatPrice(String perSeatPrice)
void	setPlanClassification(String planClassification)
void	setPlanFeatureSets(List<FeatureSet> planFeatureSets)
void	setPlanId(String planId)
void	setPlanName(String planName)
void	setRenewalStatus(String renewalStatus)
void	setSeatDiscounts(List<SeatDiscount> seatDiscounts)
void	setSupportIncidentFee(String supportIncidentFee)
void	setSupportPlanFee(String supportPlanFee)
AccountBillingPlan	supportIncidentFee(String supportIncidentFee)
AccountBillingPlan	supportPlanFee(String supportPlanFee)
String	toString()

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)

addAddOnsItem

public AccountBillingPlan addAddOnsItem(AddOn addOnsItem)

getAddOns

public List<AddOn> getAddOns()

Reserved:

Returns:

addOns

setAddOns

public void setAddOns(List<AddOn> addOns)

canCancelRenewal

public AccountBillingPlan canCancelRenewal(String canCancelRenewal)

getCanCancelRenewal

public String getCanCancelRenewal()

Reserved: TBD

Returns:

canCancelRenewal

setCanCancelRenewal

public void setCanCancelRenewal(String canCancelRenewal)

canUpgrade

public AccountBillingPlan canUpgrade(String canUpgrade)

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)

currencyCode

public AccountBillingPlan currencyCode(String currencyCode)

getCurrencyCode

public String getCurrencyCode()

Specifies the ISO currency code for the account.

Returns:

currencyCode

setCurrencyCode

public void setCurrencyCode(String currencyCode)

downgradePlanInformation

public AccountBillingPlan downgradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)

getDowngradePlanInformation

public DowngradePlanUpdateResponse getDowngradePlanInformation()

Get downgradePlanInformation

Returns:

downgradePlanInformation

setDowngradePlanInformation

public void setDowngradePlanInformation(DowngradePlanUpdateResponse downgradePlanInformation)

enableSupport

public AccountBillingPlan enableSupport(String enableSupport)

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)

includedSeats

public AccountBillingPlan includedSeats(String includedSeats)

getIncludedSeats

public String getIncludedSeats()

The number of seats (users) included.

Returns:

includedSeats

setIncludedSeats

public void setIncludedSeats(String includedSeats)

incrementalSeats

public AccountBillingPlan incrementalSeats(String incrementalSeats)

getIncrementalSeats

public String getIncrementalSeats()

Reserved: TBD

Returns:

incrementalSeats

setIncrementalSeats

public void setIncrementalSeats(String incrementalSeats)

isDowngrade

public AccountBillingPlan isDowngrade(String isDowngrade)

getIsDowngrade

public String getIsDowngrade()

Returns:

isDowngrade

setIsDowngrade

public void setIsDowngrade(String isDowngrade)

otherDiscountPercent

public AccountBillingPlan otherDiscountPercent(String otherDiscountPercent)

getOtherDiscountPercent

public String getOtherDiscountPercent()

Any other percentage discount for the plan.

Returns:

otherDiscountPercent

setOtherDiscountPercent

public void setOtherDiscountPercent(String otherDiscountPercent)

paymentCycle

public AccountBillingPlan paymentCycle(String paymentCycle)

getPaymentCycle

public String getPaymentCycle()

Returns:

paymentCycle

setPaymentCycle

public void setPaymentCycle(String paymentCycle)

paymentMethod

public AccountBillingPlan paymentMethod(String paymentMethod)

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)

perSeatPrice

public AccountBillingPlan perSeatPrice(String perSeatPrice)

getPerSeatPrice

public String getPerSeatPrice()

Returns:

perSeatPrice

setPerSeatPrice

public void setPerSeatPrice(String perSeatPrice)

planClassification

public AccountBillingPlan planClassification(String planClassification)

getPlanClassification

public String getPlanClassification()

Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.

Returns:

planClassification

setPlanClassification

public void setPlanClassification(String planClassification)

planFeatureSets

public AccountBillingPlan planFeatureSets(List<FeatureSet> planFeatureSets)

addPlanFeatureSetsItem

public AccountBillingPlan addPlanFeatureSetsItem(FeatureSet planFeatureSetsItem)

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)

planId

public AccountBillingPlan planId(String planId)

getPlanId

public String getPlanId()

Returns:

planId

setPlanId

public void setPlanId(String planId)

planName

public AccountBillingPlan planName(String planName)

getPlanName

public String getPlanName()

The name of the Billing Plan.

Returns:

planName

setPlanName

public void setPlanName(String planName)

renewalStatus

public AccountBillingPlan renewalStatus(String renewalStatus)

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)

seatDiscounts

public AccountBillingPlan seatDiscounts(List<SeatDiscount> seatDiscounts)

addSeatDiscountsItem

public AccountBillingPlan addSeatDiscountsItem(SeatDiscount seatDiscountsItem)

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)

supportIncidentFee

public AccountBillingPlan supportIncidentFee(String supportIncidentFee)

getSupportIncidentFee

public String getSupportIncidentFee()

The support incident fee charged for each support incident.

Returns:

supportIncidentFee

setSupportIncidentFee

public void setSupportIncidentFee(String supportIncidentFee)

supportPlanFee

public AccountBillingPlan supportPlanFee(String supportPlanFee)

getSupportPlanFee

public String getSupportPlanFee()

The support plan fee charged for this plan.

Returns:

supportPlanFee

setSupportPlanFee

public void setSupportPlanFee(String supportPlanFee)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object