Documentation

AccountBillingPlan
in package
implements ModelInterface, ArrayAccess

AccountBillingPlan Class Doc Comment

Tags
category

Class

description

Contains information about an account billing plan.

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAddOns()  : array<string|int, AddOn>
Gets add_ons
getAppStoreReceiptExpirationDate()  : string|null
Gets app_store_receipt_expiration_date
getAppStoreReceiptPurchaseDate()  : string|null
Gets app_store_receipt_purchase_date
getCanCancelRenewal()  : string|null
Gets can_cancel_renewal
getCanUpgrade()  : string|null
Gets can_upgrade
getCurrencyCode()  : string|null
Gets currency_code
getDowngradePlanInformation()  : DowngradePlanUpdateResponse
Gets downgrade_plan_information
getEnableSupport()  : string|null
Gets enable_support
getIncludedSeats()  : string|null
Gets included_seats
getIncrementalSeats()  : string|null
Gets incremental_seats
getIsDowngrade()  : string|null
Gets is_downgrade
getModelName()  : string
The original name of the model.
getNotificationType()  : string|null
Gets notification_type
getOtherDiscountPercent()  : string|null
Gets other_discount_percent
getPaymentCycle()  : string|null
Gets payment_cycle
getPaymentMethod()  : string|null
Gets payment_method
getPerSeatPrice()  : string|null
Gets per_seat_price
getPlanClassification()  : string|null
Gets plan_classification
getPlanFeatureSets()  : array<string|int, FeatureSet>
Gets plan_feature_sets
getPlanId()  : string|null
Gets plan_id
getPlanName()  : string|null
Gets plan_name
getPlanStartDate()  : string|null
Gets plan_start_date
getProductId()  : string|null
Gets product_id
getRenewalDate()  : string|null
Gets renewal_date
getRenewalStatus()  : string|null
Gets renewal_status
getSeatDiscounts()  : array<string|int, SeatDiscount>
Gets seat_discounts
getSubscriptionStartDate()  : string|null
Gets subscription_start_date
getSupportIncidentFee()  : string|null
Gets support_incident_fee
getSupportPlanFee()  : string|null
Gets support_plan_fee
getTaxExemptId()  : string|null
Gets tax_exempt_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAddOns()  : $this
Sets add_ons
setAppStoreReceiptExpirationDate()  : $this
Sets app_store_receipt_expiration_date
setAppStoreReceiptPurchaseDate()  : $this
Sets app_store_receipt_purchase_date
setCanCancelRenewal()  : $this
Sets can_cancel_renewal
setCanUpgrade()  : $this
Sets can_upgrade
setCurrencyCode()  : $this
Sets currency_code
setDowngradePlanInformation()  : $this
Sets downgrade_plan_information
setEnableSupport()  : $this
Sets enable_support
setIncludedSeats()  : $this
Sets included_seats
setIncrementalSeats()  : $this
Sets incremental_seats
setIsDowngrade()  : $this
Sets is_downgrade
setNotificationType()  : $this
Sets notification_type
setOtherDiscountPercent()  : $this
Sets other_discount_percent
setPaymentCycle()  : $this
Sets payment_cycle
setPaymentMethod()  : $this
Sets payment_method
setPerSeatPrice()  : $this
Sets per_seat_price
setPlanClassification()  : $this
Sets plan_classification
setPlanFeatureSets()  : $this
Sets plan_feature_sets
setPlanId()  : $this
Sets plan_id
setPlanName()  : $this
Sets plan_name
setPlanStartDate()  : $this
Sets plan_start_date
setProductId()  : $this
Sets product_id
setRenewalDate()  : $this
Sets renewal_date
setRenewalStatus()  : $this
Sets renewal_status
setSeatDiscounts()  : $this
Sets seat_discounts
setSubscriptionStartDate()  : $this
Sets subscription_start_date
setSupportIncidentFee()  : $this
Sets support_incident_fee
setSupportPlanFee()  : $this
Sets support_plan_fee
setTaxExemptId()  : $this
Sets tax_exempt_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['add_ons' => 'addOns', 'app_store_receipt_expiration_date' => 'appStoreReceiptExpirationDate', 'app_store_receipt_purchase_date' => 'appStoreReceiptPurchaseDate', 'can_cancel_renewal' => 'canCancelRenewal', 'can_upgrade' => 'canUpgrade', 'currency_code' => 'currencyCode', 'downgrade_plan_information' => 'downgradePlanInformation', 'enable_support' => 'enableSupport', 'included_seats' => 'includedSeats', 'incremental_seats' => 'incrementalSeats', 'is_downgrade' => 'isDowngrade', 'notification_type' => 'notificationType', 'other_discount_percent' => 'otherDiscountPercent', 'payment_cycle' => 'paymentCycle', 'payment_method' => 'paymentMethod', 'per_seat_price' => 'perSeatPrice', 'plan_classification' => 'planClassification', 'plan_feature_sets' => 'planFeatureSets', 'plan_id' => 'planId', 'plan_name' => 'planName', 'plan_start_date' => 'planStartDate', 'product_id' => 'productId', 'renewal_date' => 'renewalDate', 'renewal_status' => 'renewalStatus', 'seat_discounts' => 'seatDiscounts', 'subscription_start_date' => 'subscriptionStartDate', 'support_incident_fee' => 'supportIncidentFee', 'support_plan_fee' => 'supportPlanFee', 'tax_exempt_id' => 'taxExemptId']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['add_ons' => 'getAddOns', 'app_store_receipt_expiration_date' => 'getAppStoreReceiptExpirationDate', 'app_store_receipt_purchase_date' => 'getAppStoreReceiptPurchaseDate', 'can_cancel_renewal' => 'getCanCancelRenewal', 'can_upgrade' => 'getCanUpgrade', 'currency_code' => 'getCurrencyCode', 'downgrade_plan_information' => 'getDowngradePlanInformation', 'enable_support' => 'getEnableSupport', 'included_seats' => 'getIncludedSeats', 'incremental_seats' => 'getIncrementalSeats', 'is_downgrade' => 'getIsDowngrade', 'notification_type' => 'getNotificationType', 'other_discount_percent' => 'getOtherDiscountPercent', 'payment_cycle' => 'getPaymentCycle', 'payment_method' => 'getPaymentMethod', 'per_seat_price' => 'getPerSeatPrice', 'plan_classification' => 'getPlanClassification', 'plan_feature_sets' => 'getPlanFeatureSets', 'plan_id' => 'getPlanId', 'plan_name' => 'getPlanName', 'plan_start_date' => 'getPlanStartDate', 'product_id' => 'getProductId', 'renewal_date' => 'getRenewalDate', 'renewal_status' => 'getRenewalStatus', 'seat_discounts' => 'getSeatDiscounts', 'subscription_start_date' => 'getSubscriptionStartDate', 'support_incident_fee' => 'getSupportIncidentFee', 'support_plan_fee' => 'getSupportPlanFee', 'tax_exempt_id' => 'getTaxExemptId']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['add_ons' => 'setAddOns', 'app_store_receipt_expiration_date' => 'setAppStoreReceiptExpirationDate', 'app_store_receipt_purchase_date' => 'setAppStoreReceiptPurchaseDate', 'can_cancel_renewal' => 'setCanCancelRenewal', 'can_upgrade' => 'setCanUpgrade', 'currency_code' => 'setCurrencyCode', 'downgrade_plan_information' => 'setDowngradePlanInformation', 'enable_support' => 'setEnableSupport', 'included_seats' => 'setIncludedSeats', 'incremental_seats' => 'setIncrementalSeats', 'is_downgrade' => 'setIsDowngrade', 'notification_type' => 'setNotificationType', 'other_discount_percent' => 'setOtherDiscountPercent', 'payment_cycle' => 'setPaymentCycle', 'payment_method' => 'setPaymentMethod', 'per_seat_price' => 'setPerSeatPrice', 'plan_classification' => 'setPlanClassification', 'plan_feature_sets' => 'setPlanFeatureSets', 'plan_id' => 'setPlanId', 'plan_name' => 'setPlanName', 'plan_start_date' => 'setPlanStartDate', 'product_id' => 'setProductId', 'renewal_date' => 'setRenewalDate', 'renewal_status' => 'setRenewalStatus', 'seat_discounts' => 'setSeatDiscounts', 'subscription_start_date' => 'setSubscriptionStartDate', 'support_incident_fee' => 'setSupportIncidentFee', 'support_plan_fee' => 'setSupportPlanFee', 'tax_exempt_id' => 'setTaxExemptId']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['add_ons' => null, 'app_store_receipt_expiration_date' => null, 'app_store_receipt_purchase_date' => null, 'can_cancel_renewal' => null, 'can_upgrade' => null, 'currency_code' => null, 'downgrade_plan_information' => null, 'enable_support' => null, 'included_seats' => null, 'incremental_seats' => null, 'is_downgrade' => null, 'notification_type' => null, 'other_discount_percent' => null, 'payment_cycle' => null, 'payment_method' => null, 'per_seat_price' => null, 'plan_classification' => null, 'plan_feature_sets' => null, 'plan_id' => null, 'plan_name' => null, 'plan_start_date' => null, 'product_id' => null, 'renewal_date' => null, 'renewal_status' => null, 'seat_discounts' => null, 'subscription_start_date' => null, 'support_incident_fee' => null, 'support_plan_fee' => null, 'tax_exempt_id' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'accountBillingPlan'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['add_ons' => '\\DocuSign\\eSign\\Model\\AddOn[]', 'app_store_receipt_expiration_date' => '?string', 'app_store_receipt_purchase_date' => '?string', 'can_cancel_renewal' => '?string', 'can_upgrade' => '?string', 'currency_code' => '?string', 'downgrade_plan_information' => '\\DocuSign\\eSign\\Model\\DowngradePlanUpdateResponse', 'enable_support' => '?string', 'included_seats' => '?string', 'incremental_seats' => '?string', 'is_downgrade' => '?string', 'notification_type' => '?string', 'other_discount_percent' => '?string', 'payment_cycle' => '?string', 'payment_method' => '?string', 'per_seat_price' => '?string', 'plan_classification' => '?string', 'plan_feature_sets' => '\\DocuSign\\eSign\\Model\\FeatureSet[]', 'plan_id' => '?string', 'plan_name' => '?string', 'plan_start_date' => '?string', 'product_id' => '?string', 'renewal_date' => '?string', 'renewal_status' => '?string', 'seat_discounts' => '\\DocuSign\\eSign\\Model\\SeatDiscount[]', 'subscription_start_date' => '?string', 'support_incident_fee' => '?string', 'support_plan_fee' => '?string', 'tax_exempt_id' => '?string']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getAppStoreReceiptExpirationDate()

Gets app_store_receipt_expiration_date

public getAppStoreReceiptExpirationDate() : string|null
Return values
string|null —

getAppStoreReceiptPurchaseDate()

Gets app_store_receipt_purchase_date

public getAppStoreReceiptPurchaseDate() : string|null
Return values
string|null —

getCanCancelRenewal()

Gets can_cancel_renewal

public getCanCancelRenewal() : string|null
Return values
string|null —

getCanUpgrade()

Gets can_upgrade

public getCanUpgrade() : string|null
Return values
string|null —

getCurrencyCode()

Gets currency_code

public getCurrencyCode() : string|null
Return values
string|null —

getEnableSupport()

Gets enable_support

public getEnableSupport() : string|null
Return values
string|null —

getIncludedSeats()

Gets included_seats

public getIncludedSeats() : string|null
Return values
string|null —

getIncrementalSeats()

Gets incremental_seats

public getIncrementalSeats() : string|null
Return values
string|null —

getIsDowngrade()

Gets is_downgrade

public getIsDowngrade() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getNotificationType()

Gets notification_type

public getNotificationType() : string|null
Return values
string|null —

getOtherDiscountPercent()

Gets other_discount_percent

public getOtherDiscountPercent() : string|null
Return values
string|null —

getPaymentCycle()

Gets payment_cycle

public getPaymentCycle() : string|null
Return values
string|null —

getPaymentMethod()

Gets payment_method

public getPaymentMethod() : string|null
Return values
string|null —

getPerSeatPrice()

Gets per_seat_price

public getPerSeatPrice() : string|null
Return values
string|null —

getPlanClassification()

Gets plan_classification

public getPlanClassification() : string|null
Return values
string|null —

getPlanId()

Gets plan_id

public getPlanId() : string|null
Return values
string|null —

getPlanName()

Gets plan_name

public getPlanName() : string|null
Return values
string|null —

getPlanStartDate()

Gets plan_start_date

public getPlanStartDate() : string|null
Return values
string|null —

getProductId()

Gets product_id

public getProductId() : string|null
Return values
string|null —

getRenewalDate()

Gets renewal_date

public getRenewalDate() : string|null
Return values
string|null —

getRenewalStatus()

Gets renewal_status

public getRenewalStatus() : string|null
Return values
string|null —

getSubscriptionStartDate()

Gets subscription_start_date

public getSubscriptionStartDate() : string|null
Return values
string|null —

getSupportIncidentFee()

Gets support_incident_fee

public getSupportIncidentFee() : string|null
Return values
string|null —

getSupportPlanFee()

Gets support_plan_fee

public getSupportPlanFee() : string|null
Return values
string|null —

getTaxExemptId()

Gets tax_exempt_id

public getTaxExemptId() : string|null
Return values
string|null —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

setAddOns()

Sets add_ons

public setAddOns(array<string|int, AddOn> $add_ons) : $this
Parameters
$add_ons : array<string|int, AddOn>

Reserved:

Return values
$this —

setAppStoreReceiptExpirationDate()

Sets app_store_receipt_expiration_date

public setAppStoreReceiptExpirationDate(string|null $app_store_receipt_expiration_date) : $this
Parameters
$app_store_receipt_expiration_date : string|null
Return values
$this —

setAppStoreReceiptPurchaseDate()

Sets app_store_receipt_purchase_date

public setAppStoreReceiptPurchaseDate(string|null $app_store_receipt_purchase_date) : $this
Parameters
$app_store_receipt_purchase_date : string|null
Return values
$this —

setCanCancelRenewal()

Sets can_cancel_renewal

public setCanCancelRenewal(string|null $can_cancel_renewal) : $this
Parameters
$can_cancel_renewal : string|null

Reserved: TBD

Return values
$this —

setCanUpgrade()

Sets can_upgrade

public setCanUpgrade(string|null $can_upgrade) : $this
Parameters
$can_upgrade : string|null

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

Return values
$this —

setCurrencyCode()

Sets currency_code

public setCurrencyCode(string|null $currency_code) : $this
Parameters
$currency_code : string|null

Specifies the ISO currency code for the account.

Return values
$this —

setEnableSupport()

Sets enable_support

public setEnableSupport(string|null $enable_support) : $this
Parameters
$enable_support : string|null

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

Return values
$this —

setIncludedSeats()

Sets included_seats

public setIncludedSeats(string|null $included_seats) : $this
Parameters
$included_seats : string|null

The number of seats (users) included.

Return values
$this —

setIncrementalSeats()

Sets incremental_seats

public setIncrementalSeats(string|null $incremental_seats) : $this
Parameters
$incremental_seats : string|null

Reserved: TBD

Return values
$this —

setIsDowngrade()

Sets is_downgrade

public setIsDowngrade(string|null $is_downgrade) : $this
Parameters
$is_downgrade : string|null
Return values
$this —

setNotificationType()

Sets notification_type

public setNotificationType(string|null $notification_type) : $this
Parameters
$notification_type : string|null
Return values
$this —

setOtherDiscountPercent()

Sets other_discount_percent

public setOtherDiscountPercent(string|null $other_discount_percent) : $this
Parameters
$other_discount_percent : string|null

Any other percentage discount for the plan.

Return values
$this —

setPaymentCycle()

Sets payment_cycle

public setPaymentCycle(string|null $payment_cycle) : $this
Parameters
$payment_cycle : string|null
Return values
$this —

setPaymentMethod()

Sets payment_method

public setPaymentMethod(string|null $payment_method) : $this
Parameters
$payment_method : string|null

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

Return values
$this —

setPerSeatPrice()

Sets per_seat_price

public setPerSeatPrice(string|null $per_seat_price) : $this
Parameters
$per_seat_price : string|null
Return values
$this —

setPlanClassification()

Sets plan_classification

public setPlanClassification(string|null $plan_classification) : $this
Parameters
$plan_classification : string|null

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

Return values
$this —

setPlanFeatureSets()

Sets plan_feature_sets

public setPlanFeatureSets(array<string|int, FeatureSet> $plan_feature_sets) : $this
Parameters
$plan_feature_sets : array<string|int, FeatureSet>

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

Return values
$this —

setPlanId()

Sets plan_id

public setPlanId(string|null $plan_id) : $this
Parameters
$plan_id : string|null
Return values
$this —

setPlanName()

Sets plan_name

public setPlanName(string|null $plan_name) : $this
Parameters
$plan_name : string|null

The name of the Billing Plan.

Return values
$this —

setPlanStartDate()

Sets plan_start_date

public setPlanStartDate(string|null $plan_start_date) : $this
Parameters
$plan_start_date : string|null
Return values
$this —

setProductId()

Sets product_id

public setProductId(string|null $product_id) : $this
Parameters
$product_id : string|null
Return values
$this —

setRenewalDate()

Sets renewal_date

public setRenewalDate(string|null $renewal_date) : $this
Parameters
$renewal_date : string|null
Return values
$this —

setRenewalStatus()

Sets renewal_status

public setRenewalStatus(string|null $renewal_status) : $this
Parameters
$renewal_status : string|null

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.

Return values
$this —

setSeatDiscounts()

Sets seat_discounts

public setSeatDiscounts(array<string|int, SeatDiscount> $seat_discounts) : $this
Parameters
$seat_discounts : array<string|int, SeatDiscount>

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

Return values
$this —

setSubscriptionStartDate()

Sets subscription_start_date

public setSubscriptionStartDate(string|null $subscription_start_date) : $this
Parameters
$subscription_start_date : string|null
Return values
$this —

setSupportIncidentFee()

Sets support_incident_fee

public setSupportIncidentFee(string|null $support_incident_fee) : $this
Parameters
$support_incident_fee : string|null

The support incident fee charged for each support incident.

Return values
$this —

setSupportPlanFee()

Sets support_plan_fee

public setSupportPlanFee(string|null $support_plan_fee) : $this
Parameters
$support_plan_fee : string|null

The support plan fee charged for this plan.

Return values
$this —

setTaxExemptId()

Sets tax_exempt_id

public setTaxExemptId(string|null $tax_exempt_id) : $this
Parameters
$tax_exempt_id : string|null
Return values
$this —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

Search results