Package com.docusign.esign.model

Class AccountBillingPlan

  • public class AccountBillingPlan
extends java.lang.Object
    Contains information about an account billing plan..

    • Constructor Detail

      • AccountBillingPlan

        public AccountBillingPlan()

    • Method Detail

      • addAddOnsItem

        public AccountBillingPlan addAddOnsItem​(AddOn addOnsItem)
        addAddOnsItem.
        Returns:
        AccountBillingPlan

      • getAddOns

        public java.util.List<AddOn> getAddOns()
        Reserved:.
        Returns:
        addOns

      • setAddOns

        public void setAddOns​(java.util.List<AddOn> addOns)
        setAddOns.

      • appStoreReceiptExpirationDate

        public AccountBillingPlan appStoreReceiptExpirationDate​(java.lang.String appStoreReceiptExpirationDate)
        appStoreReceiptExpirationDate.
        Returns:
        AccountBillingPlan

      • getAppStoreReceiptExpirationDate

        public java.lang.String getAppStoreReceiptExpirationDate()
        .
        Returns:
        appStoreReceiptExpirationDate

      • setAppStoreReceiptExpirationDate

        public void setAppStoreReceiptExpirationDate​(java.lang.String appStoreReceiptExpirationDate)
        setAppStoreReceiptExpirationDate.

      • appStoreReceiptPurchaseDate

        public AccountBillingPlan appStoreReceiptPurchaseDate​(java.lang.String appStoreReceiptPurchaseDate)
        appStoreReceiptPurchaseDate.
        Returns:
        AccountBillingPlan

      • getAppStoreReceiptPurchaseDate

        public java.lang.String getAppStoreReceiptPurchaseDate()
        .
        Returns:
        appStoreReceiptPurchaseDate

      • setAppStoreReceiptPurchaseDate

        public void setAppStoreReceiptPurchaseDate​(java.lang.String appStoreReceiptPurchaseDate)
        setAppStoreReceiptPurchaseDate.

      • canCancelRenewal

        public AccountBillingPlan canCancelRenewal​(java.lang.String canCancelRenewal)
        canCancelRenewal.
        Returns:
        AccountBillingPlan

      • getCanCancelRenewal

        public java.lang.String getCanCancelRenewal()
        Reserved: TBD.
        Returns:
        canCancelRenewal

      • setCanCancelRenewal

        public void setCanCancelRenewal​(java.lang.String canCancelRenewal)
        setCanCancelRenewal.

      • canUpgrade

        public AccountBillingPlan canUpgrade​(java.lang.String canUpgrade)
        canUpgrade.
        Returns:
        AccountBillingPlan

      • getCanUpgrade

        public java.lang.String getCanUpgrade()
        When set to **true**, specifies that you can upgrade the account through the API..
        Returns:
        canUpgrade

      • setCanUpgrade

        public void setCanUpgrade​(java.lang.String canUpgrade)
        setCanUpgrade.

      • currencyCode

        public AccountBillingPlan currencyCode​(java.lang.String currencyCode)
        currencyCode.
        Returns:
        AccountBillingPlan

      • getCurrencyCode

        public java.lang.String getCurrencyCode()
        Specifies the ISO currency code for the account..
        Returns:
        currencyCode

      • setCurrencyCode

        public void setCurrencyCode​(java.lang.String currencyCode)
        setCurrencyCode.

      • getDowngradePlanInformation

        public DowngradePlanUpdateResponse getDowngradePlanInformation()
        Get downgradePlanInformation.
        Returns:
        downgradePlanInformation

      • setDowngradePlanInformation

        public void setDowngradePlanInformation​(DowngradePlanUpdateResponse downgradePlanInformation)
        setDowngradePlanInformation.

      • enableSupport

        public AccountBillingPlan enableSupport​(java.lang.String enableSupport)
        enableSupport.
        Returns:
        AccountBillingPlan

      • getEnableSupport

        public java.lang.String getEnableSupport()
        When set to **true**, then customer support is provided as part of the account plan..
        Returns:
        enableSupport

      • setEnableSupport

        public void setEnableSupport​(java.lang.String enableSupport)
        setEnableSupport.

      • includedSeats

        public AccountBillingPlan includedSeats​(java.lang.String includedSeats)
        includedSeats.
        Returns:
        AccountBillingPlan

      • getIncludedSeats

        public java.lang.String getIncludedSeats()
        The number of seats (users) included..
        Returns:
        includedSeats

      • setIncludedSeats

        public void setIncludedSeats​(java.lang.String includedSeats)
        setIncludedSeats.

      • incrementalSeats

        public AccountBillingPlan incrementalSeats​(java.lang.String incrementalSeats)
        incrementalSeats.
        Returns:
        AccountBillingPlan

      • getIncrementalSeats

        public java.lang.String getIncrementalSeats()
        Reserved: TBD.
        Returns:
        incrementalSeats

      • setIncrementalSeats

        public void setIncrementalSeats​(java.lang.String incrementalSeats)
        setIncrementalSeats.

      • isDowngrade

        public AccountBillingPlan isDowngrade​(java.lang.String isDowngrade)
        isDowngrade.
        Returns:
        AccountBillingPlan

      • getIsDowngrade

        public java.lang.String getIsDowngrade()
        .
        Returns:
        isDowngrade

      • setIsDowngrade

        public void setIsDowngrade​(java.lang.String isDowngrade)
        setIsDowngrade.

      • notificationType

        public AccountBillingPlan notificationType​(java.lang.String notificationType)
        notificationType.
        Returns:
        AccountBillingPlan

      • getNotificationType

        public java.lang.String getNotificationType()
        .
        Returns:
        notificationType

      • setNotificationType

        public void setNotificationType​(java.lang.String notificationType)
        setNotificationType.

      • otherDiscountPercent

        public AccountBillingPlan otherDiscountPercent​(java.lang.String otherDiscountPercent)
        otherDiscountPercent.
        Returns:
        AccountBillingPlan

      • getOtherDiscountPercent

        public java.lang.String getOtherDiscountPercent()
        Any other percentage discount for the plan. .
        Returns:
        otherDiscountPercent

      • setOtherDiscountPercent

        public void setOtherDiscountPercent​(java.lang.String otherDiscountPercent)
        setOtherDiscountPercent.

      • paymentCycle

        public AccountBillingPlan paymentCycle​(java.lang.String paymentCycle)
        paymentCycle.
        Returns:
        AccountBillingPlan

      • getPaymentCycle

        public java.lang.String getPaymentCycle()
        .
        Returns:
        paymentCycle

      • setPaymentCycle

        public void setPaymentCycle​(java.lang.String paymentCycle)
        setPaymentCycle.

      • paymentMethod

        public AccountBillingPlan paymentMethod​(java.lang.String paymentMethod)
        paymentMethod.
        Returns:
        AccountBillingPlan

      • getPaymentMethod

        public java.lang.String getPaymentMethod()
        The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. .
        Returns:
        paymentMethod

      • setPaymentMethod

        public void setPaymentMethod​(java.lang.String paymentMethod)
        setPaymentMethod.

      • perSeatPrice

        public AccountBillingPlan perSeatPrice​(java.lang.String perSeatPrice)
        perSeatPrice.
        Returns:
        AccountBillingPlan

      • getPerSeatPrice

        public java.lang.String getPerSeatPrice()
        .
        Returns:
        perSeatPrice

      • setPerSeatPrice

        public void setPerSeatPrice​(java.lang.String perSeatPrice)
        setPerSeatPrice.

      • planClassification

        public AccountBillingPlan planClassification​(java.lang.String planClassification)
        planClassification.
        Returns:
        AccountBillingPlan

      • getPlanClassification

        public java.lang.String getPlanClassification()
        Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free..
        Returns:
        planClassification

      • setPlanClassification

        public void setPlanClassification​(java.lang.String planClassification)
        setPlanClassification.

      • planFeatureSets

        public AccountBillingPlan planFeatureSets​(java.util.List<FeatureSet> planFeatureSets)
        planFeatureSets.
        Returns:
        AccountBillingPlan

      • addPlanFeatureSetsItem

        public AccountBillingPlan addPlanFeatureSetsItem​(FeatureSet planFeatureSetsItem)
        addPlanFeatureSetsItem.
        Returns:
        AccountBillingPlan

      • getPlanFeatureSets

        public java.util.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​(java.util.List<FeatureSet> planFeatureSets)
        setPlanFeatureSets.

      • planId

        public AccountBillingPlan planId​(java.lang.String planId)
        planId.
        Returns:
        AccountBillingPlan

      • getPlanId

        public java.lang.String getPlanId()
        .
        Returns:
        planId

      • setPlanId

        public void setPlanId​(java.lang.String planId)
        setPlanId.

      • planName

        public AccountBillingPlan planName​(java.lang.String planName)
        planName.
        Returns:
        AccountBillingPlan

      • getPlanName

        public java.lang.String getPlanName()
        The name of the Billing Plan..
        Returns:
        planName

      • setPlanName

        public void setPlanName​(java.lang.String planName)
        setPlanName.

      • planStartDate

        public AccountBillingPlan planStartDate​(java.lang.String planStartDate)
        planStartDate.
        Returns:
        AccountBillingPlan

      • getPlanStartDate

        public java.lang.String getPlanStartDate()
        .
        Returns:
        planStartDate

      • setPlanStartDate

        public void setPlanStartDate​(java.lang.String planStartDate)
        setPlanStartDate.

      • productId

        public AccountBillingPlan productId​(java.lang.String productId)
        productId.
        Returns:
        AccountBillingPlan

      • getProductId

        public java.lang.String getProductId()
        .
        Returns:
        productId

      • setProductId

        public void setProductId​(java.lang.String productId)
        setProductId.

      • renewalDate

        public AccountBillingPlan renewalDate​(java.lang.String renewalDate)
        renewalDate.
        Returns:
        AccountBillingPlan

      • getRenewalDate

        public java.lang.String getRenewalDate()
        .
        Returns:
        renewalDate

      • setRenewalDate

        public void setRenewalDate​(java.lang.String renewalDate)
        setRenewalDate.

      • renewalStatus

        public AccountBillingPlan renewalStatus​(java.lang.String renewalStatus)
        renewalStatus.
        Returns:
        AccountBillingPlan

      • getRenewalStatus

        public java.lang.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​(java.lang.String renewalStatus)
        setRenewalStatus.

      • addSeatDiscountsItem

        public AccountBillingPlan addSeatDiscountsItem​(SeatDiscount seatDiscountsItem)
        addSeatDiscountsItem.
        Returns:
        AccountBillingPlan

      • getSeatDiscounts

        public java.util.List<SeatDiscount> getSeatDiscounts()
        A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. .
        Returns:
        seatDiscounts

      • setSeatDiscounts

        public void setSeatDiscounts​(java.util.List<SeatDiscount> seatDiscounts)
        setSeatDiscounts.

      • subscriptionStartDate

        public AccountBillingPlan subscriptionStartDate​(java.lang.String subscriptionStartDate)
        subscriptionStartDate.
        Returns:
        AccountBillingPlan

      • getSubscriptionStartDate

        public java.lang.String getSubscriptionStartDate()
        .
        Returns:
        subscriptionStartDate

      • setSubscriptionStartDate

        public void setSubscriptionStartDate​(java.lang.String subscriptionStartDate)
        setSubscriptionStartDate.

      • supportIncidentFee

        public AccountBillingPlan supportIncidentFee​(java.lang.String supportIncidentFee)
        supportIncidentFee.
        Returns:
        AccountBillingPlan

      • getSupportIncidentFee

        public java.lang.String getSupportIncidentFee()
        The support incident fee charged for each support incident..
        Returns:
        supportIncidentFee

      • setSupportIncidentFee

        public void setSupportIncidentFee​(java.lang.String supportIncidentFee)
        setSupportIncidentFee.

      • supportPlanFee

        public AccountBillingPlan supportPlanFee​(java.lang.String supportPlanFee)
        supportPlanFee.
        Returns:
        AccountBillingPlan

      • getSupportPlanFee

        public java.lang.String getSupportPlanFee()
        The support plan fee charged for this plan..
        Returns:
        supportPlanFee

      • setSupportPlanFee

        public void setSupportPlanFee​(java.lang.String supportPlanFee)
        setSupportPlanFee.

      • taxExemptId

        public AccountBillingPlan taxExemptId​(java.lang.String taxExemptId)
        taxExemptId.
        Returns:
        AccountBillingPlan

      • getTaxExemptId

        public java.lang.String getTaxExemptId()
        .
        Returns:
        taxExemptId

      • setTaxExemptId

        public void setTaxExemptId​(java.lang.String taxExemptId)
        setTaxExemptId.

      • equals

        public boolean equals​(java.lang.Object o)
        Compares objects.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Converts the given object to string.
        Overrides:
        toString in class java.lang.Object