Documentation

BillingPlanInformation
in package
implements ModelInterface, ArrayAccess

BillingPlanInformation Class Doc Comment

Tags
category

Class

description

This object contains details about a 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
getAppStoreReceipt()  : AppStoreReceipt
Gets app_store_receipt
getBillingAddress()  : AccountAddress
Gets billing_address
getCreditCardInformation()  : CreditCardInformation
Gets credit_card_information
getDirectDebitProcessorInformation()  : DirectDebitProcessorInformation
Gets direct_debit_processor_information
getDowngradeReason()  : string|null
Gets downgrade_reason
getEnablePreAuth()  : string|null
Gets enable_pre_auth
getEnableSupport()  : string|null
Gets enable_support
getIncludedSeats()  : string|null
Gets included_seats
getIncrementalSeats()  : string|null
Gets incremental_seats
getModelName()  : string
The original name of the model.
getPaymentMethod()  : string|null
Gets payment_method
getPaymentProcessor()  : string|null
Gets payment_processor
getPaymentProcessorInformation()  : PaymentProcessorInformation
Gets payment_processor_information
getPlanInformation()  : PlanInformation
Gets plan_information
getProcessPayment()  : string|null
Gets process_payment
getReferralInformation()  : ReferralInformation
Gets referral_information
getRenewalStatus()  : string|null
Gets renewal_status
getSaleDiscountAmount()  : string|null
Gets sale_discount_amount
getSaleDiscountFixedAmount()  : string|null
Gets sale_discount_fixed_amount
getSaleDiscountPercent()  : string|null
Gets sale_discount_percent
getSaleDiscountPeriods()  : string|null
Gets sale_discount_periods
getSaleDiscountSeatPriceOverride()  : string|null
Gets sale_discount_seat_price_override
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.
setAppStoreReceipt()  : $this
Sets app_store_receipt
setBillingAddress()  : $this
Sets billing_address
setCreditCardInformation()  : $this
Sets credit_card_information
setDirectDebitProcessorInformation()  : $this
Sets direct_debit_processor_information
setDowngradeReason()  : $this
Sets downgrade_reason
setEnablePreAuth()  : $this
Sets enable_pre_auth
setEnableSupport()  : $this
Sets enable_support
setIncludedSeats()  : $this
Sets included_seats
setIncrementalSeats()  : $this
Sets incremental_seats
setPaymentMethod()  : $this
Sets payment_method
setPaymentProcessor()  : $this
Sets payment_processor
setPaymentProcessorInformation()  : $this
Sets payment_processor_information
setPlanInformation()  : $this
Sets plan_information
setProcessPayment()  : $this
Sets process_payment
setReferralInformation()  : $this
Sets referral_information
setRenewalStatus()  : $this
Sets renewal_status
setSaleDiscountAmount()  : $this
Sets sale_discount_amount
setSaleDiscountFixedAmount()  : $this
Sets sale_discount_fixed_amount
setSaleDiscountPercent()  : $this
Sets sale_discount_percent
setSaleDiscountPeriods()  : $this
Sets sale_discount_periods
setSaleDiscountSeatPriceOverride()  : $this
Sets sale_discount_seat_price_override
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 = ['app_store_receipt' => 'appStoreReceipt', 'billing_address' => 'billingAddress', 'credit_card_information' => 'creditCardInformation', 'direct_debit_processor_information' => 'directDebitProcessorInformation', 'downgrade_reason' => 'downgradeReason', 'enable_pre_auth' => 'enablePreAuth', 'enable_support' => 'enableSupport', 'included_seats' => 'includedSeats', 'incremental_seats' => 'incrementalSeats', 'payment_method' => 'paymentMethod', 'payment_processor' => 'paymentProcessor', 'payment_processor_information' => 'paymentProcessorInformation', 'plan_information' => 'planInformation', 'process_payment' => 'processPayment', 'referral_information' => 'referralInformation', 'renewal_status' => 'renewalStatus', 'sale_discount_amount' => 'saleDiscountAmount', 'sale_discount_fixed_amount' => 'saleDiscountFixedAmount', 'sale_discount_percent' => 'saleDiscountPercent', 'sale_discount_periods' => 'saleDiscountPeriods', 'sale_discount_seat_price_override' => 'saleDiscountSeatPriceOverride', '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 = ['app_store_receipt' => 'getAppStoreReceipt', 'billing_address' => 'getBillingAddress', 'credit_card_information' => 'getCreditCardInformation', 'direct_debit_processor_information' => 'getDirectDebitProcessorInformation', 'downgrade_reason' => 'getDowngradeReason', 'enable_pre_auth' => 'getEnablePreAuth', 'enable_support' => 'getEnableSupport', 'included_seats' => 'getIncludedSeats', 'incremental_seats' => 'getIncrementalSeats', 'payment_method' => 'getPaymentMethod', 'payment_processor' => 'getPaymentProcessor', 'payment_processor_information' => 'getPaymentProcessorInformation', 'plan_information' => 'getPlanInformation', 'process_payment' => 'getProcessPayment', 'referral_information' => 'getReferralInformation', 'renewal_status' => 'getRenewalStatus', 'sale_discount_amount' => 'getSaleDiscountAmount', 'sale_discount_fixed_amount' => 'getSaleDiscountFixedAmount', 'sale_discount_percent' => 'getSaleDiscountPercent', 'sale_discount_periods' => 'getSaleDiscountPeriods', 'sale_discount_seat_price_override' => 'getSaleDiscountSeatPriceOverride', 'tax_exempt_id' => 'getTaxExemptId']

$setters

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

protected static array<string|int, string> $setters = ['app_store_receipt' => 'setAppStoreReceipt', 'billing_address' => 'setBillingAddress', 'credit_card_information' => 'setCreditCardInformation', 'direct_debit_processor_information' => 'setDirectDebitProcessorInformation', 'downgrade_reason' => 'setDowngradeReason', 'enable_pre_auth' => 'setEnablePreAuth', 'enable_support' => 'setEnableSupport', 'included_seats' => 'setIncludedSeats', 'incremental_seats' => 'setIncrementalSeats', 'payment_method' => 'setPaymentMethod', 'payment_processor' => 'setPaymentProcessor', 'payment_processor_information' => 'setPaymentProcessorInformation', 'plan_information' => 'setPlanInformation', 'process_payment' => 'setProcessPayment', 'referral_information' => 'setReferralInformation', 'renewal_status' => 'setRenewalStatus', 'sale_discount_amount' => 'setSaleDiscountAmount', 'sale_discount_fixed_amount' => 'setSaleDiscountFixedAmount', 'sale_discount_percent' => 'setSaleDiscountPercent', 'sale_discount_periods' => 'setSaleDiscountPeriods', 'sale_discount_seat_price_override' => 'setSaleDiscountSeatPriceOverride', 'tax_exempt_id' => 'setTaxExemptId']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['app_store_receipt' => null, 'billing_address' => null, 'credit_card_information' => null, 'direct_debit_processor_information' => null, 'downgrade_reason' => null, 'enable_pre_auth' => null, 'enable_support' => null, 'included_seats' => null, 'incremental_seats' => null, 'payment_method' => null, 'payment_processor' => null, 'payment_processor_information' => null, 'plan_information' => null, 'process_payment' => null, 'referral_information' => null, 'renewal_status' => null, 'sale_discount_amount' => null, 'sale_discount_fixed_amount' => null, 'sale_discount_percent' => null, 'sale_discount_periods' => null, 'sale_discount_seat_price_override' => null, 'tax_exempt_id' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'billingPlanInformation'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['app_store_receipt' => '\\DocuSign\\eSign\\Model\\AppStoreReceipt', 'billing_address' => '\\DocuSign\\eSign\\Model\\AccountAddress', 'credit_card_information' => '\\DocuSign\\eSign\\Model\\CreditCardInformation', 'direct_debit_processor_information' => '\\DocuSign\\eSign\\Model\\DirectDebitProcessorInformation', 'downgrade_reason' => '?string', 'enable_pre_auth' => '?string', 'enable_support' => '?string', 'included_seats' => '?string', 'incremental_seats' => '?string', 'payment_method' => '?string', 'payment_processor' => '?string', 'payment_processor_information' => '\\DocuSign\\eSign\\Model\\PaymentProcessorInformation', 'plan_information' => '\\DocuSign\\eSign\\Model\\PlanInformation', 'process_payment' => '?string', 'referral_information' => '\\DocuSign\\eSign\\Model\\ReferralInformation', 'renewal_status' => '?string', 'sale_discount_amount' => '?string', 'sale_discount_fixed_amount' => '?string', 'sale_discount_percent' => '?string', 'sale_discount_periods' => '?string', 'sale_discount_seat_price_override' => '?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> —

getDowngradeReason()

Gets downgrade_reason

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

getEnablePreAuth()

Gets enable_pre_auth

public getEnablePreAuth() : 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 —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPaymentMethod()

Gets payment_method

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

getPaymentProcessor()

Gets payment_processor

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

getProcessPayment()

Gets process_payment

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

getRenewalStatus()

Gets renewal_status

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

getSaleDiscountAmount()

Gets sale_discount_amount

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

getSaleDiscountFixedAmount()

Gets sale_discount_fixed_amount

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

getSaleDiscountPercent()

Gets sale_discount_percent

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

getSaleDiscountPeriods()

Gets sale_discount_periods

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

getSaleDiscountSeatPriceOverride()

Gets sale_discount_seat_price_override

public getSaleDiscountSeatPriceOverride() : 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 —

setCreditCardInformation()

Sets credit_card_information

public setCreditCardInformation(CreditCardInformation $credit_card_information) : $this
Parameters
$credit_card_information : CreditCardInformation

A complex type that has information about the credit card used to pay for this account.

Return values
$this —

setDowngradeReason()

Sets downgrade_reason

public setDowngradeReason(string|null $downgrade_reason) : $this
Parameters
$downgrade_reason : string|null
Return values
$this —

setEnablePreAuth()

Sets enable_pre_auth

public setEnablePreAuth(string|null $enable_pre_auth) : $this
Parameters
$enable_pre_auth : string|null
Return values
$this —

setEnableSupport()

Sets enable_support

public setEnableSupport(string|null $enable_support) : $this
Parameters
$enable_support : string|null
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 —

setPaymentMethod()

Sets payment_method

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

setPaymentProcessor()

Sets payment_processor

public setPaymentProcessor(string|null $payment_processor) : $this
Parameters
$payment_processor : string|null
Return values
$this —

setPlanInformation()

Sets plan_information

public setPlanInformation(PlanInformation $plan_information) : $this
Parameters
$plan_information : PlanInformation

An object used to identify the features and attributes of the account being created.

Return values
$this —

setProcessPayment()

Sets process_payment

public setProcessPayment(string|null $process_payment) : $this
Parameters
$process_payment : string|null
Return values
$this —

setReferralInformation()

Sets referral_information

public setReferralInformation(ReferralInformation $referral_information) : $this
Parameters
$referral_information : ReferralInformation

A complex type that contains properties for entering referral and discount information.

Return values
$this —

setRenewalStatus()

Sets renewal_status

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

setSaleDiscountAmount()

Sets sale_discount_amount

public setSaleDiscountAmount(string|null $sale_discount_amount) : $this
Parameters
$sale_discount_amount : string|null
Return values
$this —

setSaleDiscountFixedAmount()

Sets sale_discount_fixed_amount

public setSaleDiscountFixedAmount(string|null $sale_discount_fixed_amount) : $this
Parameters
$sale_discount_fixed_amount : string|null
Return values
$this —

setSaleDiscountPercent()

Sets sale_discount_percent

public setSaleDiscountPercent(string|null $sale_discount_percent) : $this
Parameters
$sale_discount_percent : string|null
Return values
$this —

setSaleDiscountPeriods()

Sets sale_discount_periods

public setSaleDiscountPeriods(string|null $sale_discount_periods) : $this
Parameters
$sale_discount_periods : string|null
Return values
$this —

setSaleDiscountSeatPriceOverride()

Sets sale_discount_seat_price_override

public setSaleDiscountSeatPriceOverride(string|null $sale_discount_seat_price_override) : $this
Parameters
$sale_discount_seat_price_override : string|null
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