new module:model/AccountBillingPlan()
- Source:
Constructs a new AccountBillingPlan.
Contains information about an account billing plan.
Members
(inner) addOns :Array.<module:model/AddOn>
- Source:
Reserved:
Type:
- Array.<module:model/AddOn>
(inner) appStoreReceiptExpirationDate :String
- Source:
Type:
- String
(inner) appStoreReceiptPurchaseDate :String
- Source:
Type:
- String
(inner) canCancelRenewal :String
- Source:
Reserved: TBD
Type:
- String
(inner) canUpgrade :String
- Source:
When set to true, specifies that you can upgrade the account through the API.
Type:
- String
(inner) currencyCode :String
- Source:
Specifies the ISO currency code for the account.
Type:
- String
(inner) downgradePlanInformation :module:model/DowngradePlanUpdateResponse
- Source:
Type:
(inner) enableSupport :String
- Source:
When set to true, then customer support is provided as part of the account plan.
Type:
- String
(inner) includedSeats :String
- Source:
The number of seats (users) included.
Type:
- String
(inner) incrementalSeats :String
- Source:
Reserved: TBD
Type:
- String
(inner) isDowngrade :String
- Source:
Type:
- String
(inner) notificationType :String
- Source:
Type:
- String
(inner) otherDiscountPercent :String
- Source:
Any other percentage discount for the plan.
Type:
- String
(inner) paymentCycle :String
- Source:
Type:
- String
(inner) paymentMethod :String
- Source:
The payment method used with the plan. The possible values are: CreditCard, PurchaseOrder, Premium, or Freemium.
Type:
- String
(inner) perSeatPrice :String
- Source:
Type:
- String
(inner) planClassification :String
- Source:
Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.
Type:
- String
(inner) planFeatureSets :Array.<module:model/FeatureSet>
- Source:
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).
Type:
- Array.<module:model/FeatureSet>
(inner) planId :String
- Source:
Type:
- String
(inner) planName :String
- Source:
The name of the Billing Plan.
Type:
- String
(inner) planStartDate :String
- Source:
Type:
- String
(inner) productId :String
- Source:
Type:
- String
(inner) renewalDate :String
- Source:
Type:
- String
(inner) renewalStatus :String
- Source:
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.
Type:
- String
(inner) seatDiscounts :Array.<module:model/SeatDiscount>
- Source:
A complex type that contains any seat discount information. Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent.
Type:
- Array.<module:model/SeatDiscount>
(inner) subscriptionStartDate :String
- Source:
Type:
- String
(inner) supportIncidentFee :String
- Source:
The support incident fee charged for each support incident.
Type:
- String
(inner) supportPlanFee :String
- Source:
The support plan fee charged for this plan.
Type:
- String
(inner) taxExemptId :String
- Source:
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/AccountBillingPlan}
- Source:
Constructs a AccountBillingPlan from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/AccountBillingPlan | Optional instance to populate. |
Returns:
The populated AccountBillingPlan instance.