Contains information about an account billing plan. More...

Inheritance diagram for DocuSign.eSign.Model.AccountBillingPlan:

Public Member Functions
	AccountBillingPlan (List< AddOn > AddOns=default(List< AddOn >), string AppStoreReceiptExpirationDate=default(string), string AppStoreReceiptPurchaseDate=default(string), string CanCancelRenewal=default(string), string CanUpgrade=default(string), string CurrencyCode=default(string), DowngradePlanUpdateResponse DowngradePlanInformation=default(DowngradePlanUpdateResponse), string EnableSupport=default(string), string IncludedSeats=default(string), string IncrementalSeats=default(string), string IsDowngrade=default(string), string NotificationType=default(string), string OtherDiscountPercent=default(string), string PaymentCycle=default(string), string PaymentMethod=default(string), string PerSeatPrice=default(string), string PlanClassification=default(string), List< FeatureSet > PlanFeatureSets=default(List< FeatureSet >), string PlanId=default(string), string PlanName=default(string), string PlanStartDate=default(string), string ProductId=default(string), string RenewalDate=default(string), string RenewalStatus=default(string), List< SeatDiscount > SeatDiscounts=default(List< SeatDiscount >), string SubscriptionStartDate=default(string), string SupportIncidentFee=default(string), string SupportPlanFee=default(string), string TaxExemptId=default(string))
	Initializes a new instance of the AccountBillingPlan class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (AccountBillingPlan other)
	Returns true if AccountBillingPlan instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
List< AddOn >	AddOns `[get, set]`
	Reserved: More...

string	AppStoreReceiptExpirationDate `[get, set]`
	Gets or Sets AppStoreReceiptExpirationDate More...

string	AppStoreReceiptPurchaseDate `[get, set]`
	Gets or Sets AppStoreReceiptPurchaseDate More...

string	CanCancelRenewal `[get, set]`
	Reserved: TBD More...

string	CanUpgrade `[get, set]`
	When set to true, specifies that you can upgrade the account through the API. More...

string	CurrencyCode `[get, set]`
	Specifies the ISO currency code for the account. More...

DowngradePlanUpdateResponse	DowngradePlanInformation `[get, set]`
	Gets or Sets DowngradePlanInformation More...

string	EnableSupport `[get, set]`
	When set to true, then customer support is provided as part of the account plan. More...

string	IncludedSeats `[get, set]`
	The number of seats (users) included. More...

string	IncrementalSeats `[get, set]`
	Reserved: TBD More...

string	IsDowngrade `[get, set]`
	Gets or Sets IsDowngrade More...

string	NotificationType `[get, set]`
	Gets or Sets NotificationType More...

string	OtherDiscountPercent `[get, set]`
	Any other percentage discount for the plan. More...

string	PaymentCycle `[get, set]`
	Gets or Sets PaymentCycle More...

string	PaymentMethod `[get, set]`
	The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. More...

string	PerSeatPrice `[get, set]`
	Gets or Sets PerSeatPrice More...

string	PlanClassification `[get, set]`
	Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. More...

List< FeatureSet >	PlanFeatureSets `[get, set]`
	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). More...

string	PlanId `[get, set]`
	Gets or Sets PlanId More...

string	PlanName `[get, set]`
	The name of the Billing Plan. More...

string	PlanStartDate `[get, set]`
	Gets or Sets PlanStartDate More...

string	ProductId `[get, set]`
	Gets or Sets ProductId More...

string	RenewalDate `[get, set]`
	Gets or Sets RenewalDate More...

string	RenewalStatus `[get, set]`
	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. More...

List< SeatDiscount >	SeatDiscounts `[get, set]`
	A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. More...

string	SubscriptionStartDate `[get, set]`
	Gets or Sets SubscriptionStartDate More...

string	SupportIncidentFee `[get, set]`
	The support incident fee charged for each support incident. More...

string	SupportPlanFee `[get, set]`
	The support plan fee charged for this plan. More...

string	TaxExemptId `[get, set]`
	Gets or Sets TaxExemptId More...

Detailed Description

Contains information about an account billing plan.

Constructor & Destructor Documentation

◆ AccountBillingPlan()

DocuSign.eSign.Model.AccountBillingPlan.AccountBillingPlan	(	List< AddOn >	AddOns = `default(List<AddOn>)`,
		string	AppStoreReceiptExpirationDate = `default(string)`,
		string	AppStoreReceiptPurchaseDate = `default(string)`,
		string	CanCancelRenewal = `default(string)`,
		string	CanUpgrade = `default(string)`,
		string	CurrencyCode = `default(string)`,
		DowngradePlanUpdateResponse	DowngradePlanInformation = `default(DowngradePlanUpdateResponse)`,
		string	EnableSupport = `default(string)`,
		string	IncludedSeats = `default(string)`,
		string	IncrementalSeats = `default(string)`,
		string	IsDowngrade = `default(string)`,
		string	NotificationType = `default(string)`,
		string	OtherDiscountPercent = `default(string)`,
		string	PaymentCycle = `default(string)`,
		string	PaymentMethod = `default(string)`,
		string	PerSeatPrice = `default(string)`,
		string	PlanClassification = `default(string)`,
		List< FeatureSet >	PlanFeatureSets = `default(List<FeatureSet>)`,
		string	PlanId = `default(string)`,
		string	PlanName = `default(string)`,
		string	PlanStartDate = `default(string)`,
		string	ProductId = `default(string)`,
		string	RenewalDate = `default(string)`,
		string	RenewalStatus = `default(string)`,
		List< SeatDiscount >	SeatDiscounts = `default(List<SeatDiscount>)`,
		string	SubscriptionStartDate = `default(string)`,
		string	SupportIncidentFee = `default(string)`,
		string	SupportPlanFee = `default(string)`,
		string	TaxExemptId = `default(string)`
	)

inline

Initializes a new instance of the AccountBillingPlan class.

Parameters

AddOns	Reserved:.
AppStoreReceiptExpirationDate	AppStoreReceiptExpirationDate.
AppStoreReceiptPurchaseDate	AppStoreReceiptPurchaseDate.
CanCancelRenewal	Reserved: TBD.
CanUpgrade	When set to true, specifies that you can upgrade the account through the API..
CurrencyCode	Specifies the ISO currency code for the account..
DowngradePlanInformation	DowngradePlanInformation.
EnableSupport	When set to true, then customer support is provided as part of the account plan..
IncludedSeats	The number of seats (users) included..
IncrementalSeats	Reserved: TBD.
IsDowngrade	IsDowngrade.
NotificationType	NotificationType.
OtherDiscountPercent	Any other percentage discount for the plan. .
PaymentCycle	PaymentCycle.
PaymentMethod	The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium. .
PerSeatPrice	PerSeatPrice.
PlanClassification	Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free..
PlanFeatureSets	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). .
PlanId	PlanId.
PlanName	The name of the Billing Plan..
PlanStartDate	PlanStartDate.
ProductId	ProductId.
RenewalDate	RenewalDate.
RenewalStatus	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..
SeatDiscounts	A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent. .
SubscriptionStartDate	SubscriptionStartDate.
SupportIncidentFee	The support incident fee charged for each support incident..
SupportPlanFee	The support plan fee charged for this plan..
TaxExemptId	TaxExemptId.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.AccountBillingPlan.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.AccountBillingPlan.Equals ( AccountBillingPlan other )

inline

Returns true if AccountBillingPlan instances are equal

Parameters

other Instance of AccountBillingPlan to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.AccountBillingPlan.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.AccountBillingPlan.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.AccountBillingPlan.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AddOns

List<AddOn> DocuSign.eSign.Model.AccountBillingPlan.AddOns

getset

Reserved:

◆ AppStoreReceiptExpirationDate

string DocuSign.eSign.Model.AccountBillingPlan.AppStoreReceiptExpirationDate

getset

Gets or Sets AppStoreReceiptExpirationDate

◆ AppStoreReceiptPurchaseDate

string DocuSign.eSign.Model.AccountBillingPlan.AppStoreReceiptPurchaseDate

getset

Gets or Sets AppStoreReceiptPurchaseDate

◆ CanCancelRenewal

string DocuSign.eSign.Model.AccountBillingPlan.CanCancelRenewal

getset

Reserved: TBD

◆ CanUpgrade

string DocuSign.eSign.Model.AccountBillingPlan.CanUpgrade

getset

When set to true, specifies that you can upgrade the account through the API.

◆ CurrencyCode

string DocuSign.eSign.Model.AccountBillingPlan.CurrencyCode

getset

Specifies the ISO currency code for the account.

◆ DowngradePlanInformation

DowngradePlanUpdateResponse DocuSign.eSign.Model.AccountBillingPlan.DowngradePlanInformation

getset

Gets or Sets DowngradePlanInformation

◆ EnableSupport

string DocuSign.eSign.Model.AccountBillingPlan.EnableSupport

getset

When set to true, then customer support is provided as part of the account plan.

◆ IncludedSeats

string DocuSign.eSign.Model.AccountBillingPlan.IncludedSeats

getset

The number of seats (users) included.

◆ IncrementalSeats

string DocuSign.eSign.Model.AccountBillingPlan.IncrementalSeats

getset

Reserved: TBD

◆ IsDowngrade

string DocuSign.eSign.Model.AccountBillingPlan.IsDowngrade

getset

Gets or Sets IsDowngrade

◆ NotificationType

string DocuSign.eSign.Model.AccountBillingPlan.NotificationType

getset

Gets or Sets NotificationType

◆ OtherDiscountPercent

string DocuSign.eSign.Model.AccountBillingPlan.OtherDiscountPercent

getset

Any other percentage discount for the plan.

◆ PaymentCycle

string DocuSign.eSign.Model.AccountBillingPlan.PaymentCycle

getset

Gets or Sets PaymentCycle

◆ PaymentMethod

string DocuSign.eSign.Model.AccountBillingPlan.PaymentMethod

getset

The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium.

◆ PerSeatPrice

string DocuSign.eSign.Model.AccountBillingPlan.PerSeatPrice

getset

Gets or Sets PerSeatPrice

◆ PlanClassification

string DocuSign.eSign.Model.AccountBillingPlan.PlanClassification

getset

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

◆ PlanFeatureSets

List<FeatureSet> DocuSign.eSign.Model.AccountBillingPlan.PlanFeatureSets

getset

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).

◆ PlanId

string DocuSign.eSign.Model.AccountBillingPlan.PlanId

getset

Gets or Sets PlanId

◆ PlanName

string DocuSign.eSign.Model.AccountBillingPlan.PlanName

getset

The name of the Billing Plan.

◆ PlanStartDate

string DocuSign.eSign.Model.AccountBillingPlan.PlanStartDate

getset

Gets or Sets PlanStartDate

◆ ProductId

string DocuSign.eSign.Model.AccountBillingPlan.ProductId

getset

Gets or Sets ProductId

◆ RenewalDate

string DocuSign.eSign.Model.AccountBillingPlan.RenewalDate

getset

Gets or Sets RenewalDate

◆ RenewalStatus

string DocuSign.eSign.Model.AccountBillingPlan.RenewalStatus

getset

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.

◆ SeatDiscounts

List<SeatDiscount> DocuSign.eSign.Model.AccountBillingPlan.SeatDiscounts

getset

A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent.

◆ SubscriptionStartDate

string DocuSign.eSign.Model.AccountBillingPlan.SubscriptionStartDate

getset

Gets or Sets SubscriptionStartDate

◆ SupportIncidentFee

string DocuSign.eSign.Model.AccountBillingPlan.SupportIncidentFee

getset

The support incident fee charged for each support incident.

◆ SupportPlanFee

string DocuSign.eSign.Model.AccountBillingPlan.SupportPlanFee

getset

The support plan fee charged for this plan.

◆ TaxExemptId

string DocuSign.eSign.Model.AccountBillingPlan.TaxExemptId

getset

Gets or Sets TaxExemptId

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/AccountBillingPlan.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AccountBillingPlan()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AddOns

◆ AppStoreReceiptExpirationDate

◆ AppStoreReceiptPurchaseDate

◆ CanCancelRenewal

◆ CanUpgrade

◆ CurrencyCode

◆ DowngradePlanInformation

◆ EnableSupport

◆ IncludedSeats

◆ IncrementalSeats

◆ IsDowngrade

◆ NotificationType

◆ OtherDiscountPercent

◆ PaymentCycle

◆ PaymentMethod

◆ PerSeatPrice

◆ PlanClassification

◆ PlanFeatureSets

◆ PlanId

◆ PlanName

◆ PlanStartDate

◆ ProductId

◆ RenewalDate

◆ RenewalStatus

◆ SeatDiscounts

◆ SubscriptionStartDate

◆ SupportIncidentFee

◆ SupportPlanFee

◆ TaxExemptId