AccountBillingPlanResponse
in package
implements
ModelInterface, ArrayAccess
AccountBillingPlanResponse Class Doc Comment
Tags
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
- getBillingAddress() : AccountAddress
- Gets billing_address
- getBillingAddressIsCreditCardAddress() : string|null
- Gets billing_address_is_credit_card_address
- getBillingPlan() : AccountBillingPlan
- Gets billing_plan
- getCreditCardInformation() : CreditCardInformation
- Gets credit_card_information
- getDirectDebitProcessorInformation() : DirectDebitProcessorInformation
- Gets direct_debit_processor_information
- getDowngradePlanInformation() : DowngradePlanUpdateResponse
- Gets downgrade_plan_information
- getDowngradeRequestInformation() : DowngradeRequestInformation
- Gets downgrade_request_information
- getEntityInformation() : BillingEntityInformationResponse
- Gets entity_information
- getModelName() : string
- The original name of the model.
- getPaymentMethod() : string|null
- Gets payment_method
- getPaymentProcessorInformation() : PaymentProcessorInformation
- Gets payment_processor_information
- getReferralInformation() : ReferralInformation
- Gets referral_information
- getSuccessorPlans() : array<string|int, BillingPlan>
- Gets successor_plans
- 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.
- setBillingAddress() : $this
- Sets billing_address
- setBillingAddressIsCreditCardAddress() : $this
- Sets billing_address_is_credit_card_address
- setBillingPlan() : $this
- Sets billing_plan
- setCreditCardInformation() : $this
- Sets credit_card_information
- setDirectDebitProcessorInformation() : $this
- Sets direct_debit_processor_information
- setDowngradePlanInformation() : $this
- Sets downgrade_plan_information
- setDowngradeRequestInformation() : $this
- Sets downgrade_request_information
- setEntityInformation() : $this
- Sets entity_information
- setPaymentMethod() : $this
- Sets payment_method
- setPaymentProcessorInformation() : $this
- Sets payment_processor_information
- setReferralInformation() : $this
- Sets referral_information
- setSuccessorPlans() : $this
- Sets successor_plans
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['billing_address' => 'billingAddress', 'billing_address_is_credit_card_address' => 'billingAddressIsCreditCardAddress', 'billing_plan' => 'billingPlan', 'credit_card_information' => 'creditCardInformation', 'direct_debit_processor_information' => 'directDebitProcessorInformation', 'downgrade_plan_information' => 'downgradePlanInformation', 'downgrade_request_information' => 'downgradeRequestInformation', 'entity_information' => 'entityInformation', 'payment_method' => 'paymentMethod', 'payment_processor_information' => 'paymentProcessorInformation', 'referral_information' => 'referralInformation', 'successor_plans' => 'successorPlans', '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
= ['billing_address' => 'getBillingAddress', 'billing_address_is_credit_card_address' => 'getBillingAddressIsCreditCardAddress', 'billing_plan' => 'getBillingPlan', 'credit_card_information' => 'getCreditCardInformation', 'direct_debit_processor_information' => 'getDirectDebitProcessorInformation', 'downgrade_plan_information' => 'getDowngradePlanInformation', 'downgrade_request_information' => 'getDowngradeRequestInformation', 'entity_information' => 'getEntityInformation', 'payment_method' => 'getPaymentMethod', 'payment_processor_information' => 'getPaymentProcessorInformation', 'referral_information' => 'getReferralInformation', 'successor_plans' => 'getSuccessorPlans', 'tax_exempt_id' => 'getTaxExemptId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['billing_address' => 'setBillingAddress', 'billing_address_is_credit_card_address' => 'setBillingAddressIsCreditCardAddress', 'billing_plan' => 'setBillingPlan', 'credit_card_information' => 'setCreditCardInformation', 'direct_debit_processor_information' => 'setDirectDebitProcessorInformation', 'downgrade_plan_information' => 'setDowngradePlanInformation', 'downgrade_request_information' => 'setDowngradeRequestInformation', 'entity_information' => 'setEntityInformation', 'payment_method' => 'setPaymentMethod', 'payment_processor_information' => 'setPaymentProcessorInformation', 'referral_information' => 'setReferralInformation', 'successor_plans' => 'setSuccessorPlans', 'tax_exempt_id' => 'setTaxExemptId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['billing_address' => null, 'billing_address_is_credit_card_address' => null, 'billing_plan' => null, 'credit_card_information' => null, 'direct_debit_processor_information' => null, 'downgrade_plan_information' => null, 'downgrade_request_information' => null, 'entity_information' => null, 'payment_method' => null, 'payment_processor_information' => null, 'referral_information' => null, 'successor_plans' => null, 'tax_exempt_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'accountBillingPlanResponse'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['billing_address' => '\\DocuSign\\eSign\\Model\\AccountAddress', 'billing_address_is_credit_card_address' => '?string', 'billing_plan' => '\\DocuSign\\eSign\\Model\\AccountBillingPlan', 'credit_card_information' => '\\DocuSign\\eSign\\Model\\CreditCardInformation', 'direct_debit_processor_information' => '\\DocuSign\\eSign\\Model\\DirectDebitProcessorInformation', 'downgrade_plan_information' => '\\DocuSign\\eSign\\Model\\DowngradePlanUpdateResponse', 'downgrade_request_information' => '\\DocuSign\\eSign\\Model\\DowngradeRequestInformation', 'entity_information' => '\\DocuSign\\eSign\\Model\\BillingEntityInformationResponse', 'payment_method' => '?string', 'payment_processor_information' => '\\DocuSign\\eSign\\Model\\PaymentProcessorInformation', 'referral_information' => '\\DocuSign\\eSign\\Model\\ReferralInformation', 'successor_plans' => '\\DocuSign\\eSign\\Model\\BillingPlan[]', '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> —getBillingAddress()
Gets billing_address
public
getBillingAddress() : AccountAddress
Return values
AccountAddress —getBillingAddressIsCreditCardAddress()
Gets billing_address_is_credit_card_address
public
getBillingAddressIsCreditCardAddress() : string|null
Return values
string|null —getBillingPlan()
Gets billing_plan
public
getBillingPlan() : AccountBillingPlan
Return values
AccountBillingPlan —getCreditCardInformation()
Gets credit_card_information
public
getCreditCardInformation() : CreditCardInformation
Return values
CreditCardInformation —getDirectDebitProcessorInformation()
Gets direct_debit_processor_information
public
getDirectDebitProcessorInformation() : DirectDebitProcessorInformation
Return values
DirectDebitProcessorInformation —getDowngradePlanInformation()
Gets downgrade_plan_information
public
getDowngradePlanInformation() : DowngradePlanUpdateResponse
Return values
DowngradePlanUpdateResponse —getDowngradeRequestInformation()
Gets downgrade_request_information
public
getDowngradeRequestInformation() : DowngradeRequestInformation
Return values
DowngradeRequestInformation —getEntityInformation()
Gets entity_information
public
getEntityInformation() : BillingEntityInformationResponse
Return values
BillingEntityInformationResponse —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 —getPaymentProcessorInformation()
Gets payment_processor_information
public
getPaymentProcessorInformation() : PaymentProcessorInformation
Return values
PaymentProcessorInformation —getReferralInformation()
Gets referral_information
public
getReferralInformation() : ReferralInformation
Return values
ReferralInformation —getSuccessorPlans()
Gets successor_plans
public
getSuccessorPlans() : array<string|int, BillingPlan>
Return values
array<string|int, BillingPlan> —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 —setBillingAddress()
Sets billing_address
public
setBillingAddress(AccountAddress $billing_address) : $this
Parameters
- $billing_address : AccountAddress
-
The billing address for the account.
Return values
$this —setBillingAddressIsCreditCardAddress()
Sets billing_address_is_credit_card_address
public
setBillingAddressIsCreditCardAddress(string|null $billing_address_is_credit_card_address) : $this
Parameters
- $billing_address_is_credit_card_address : string|null
-
When set to true, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.
Return values
$this —setBillingPlan()
Sets billing_plan
public
setBillingPlan(AccountBillingPlan $billing_plan) : $this
Parameters
- $billing_plan : AccountBillingPlan
-
An object that contains details about the billing plan.
Return values
$this —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 —setDirectDebitProcessorInformation()
Sets direct_debit_processor_information
public
setDirectDebitProcessorInformation(DirectDebitProcessorInformation $direct_debit_processor_information) : $this
Parameters
- $direct_debit_processor_information : DirectDebitProcessorInformation
-
Information about the bank that processes direct debits for the payment plan.
Return values
$this —setDowngradePlanInformation()
Sets downgrade_plan_information
public
setDowngradePlanInformation(DowngradePlanUpdateResponse $downgrade_plan_information) : $this
Parameters
- $downgrade_plan_information : DowngradePlanUpdateResponse
Return values
$this —setDowngradeRequestInformation()
Sets downgrade_request_information
public
setDowngradeRequestInformation(DowngradeRequestInformation $downgrade_request_information) : $this
Parameters
- $downgrade_request_information : DowngradeRequestInformation
Return values
$this —setEntityInformation()
Sets entity_information
public
setEntityInformation(BillingEntityInformationResponse $entity_information) : $this
Parameters
- $entity_information : BillingEntityInformationResponse
Return values
$this —setPaymentMethod()
Sets payment_method
public
setPaymentMethod(string|null $payment_method) : $this
Parameters
- $payment_method : string|null
Return values
$this —setPaymentProcessorInformation()
Sets payment_processor_information
public
setPaymentProcessorInformation(PaymentProcessorInformation $payment_processor_information) : $this
Parameters
- $payment_processor_information : PaymentProcessorInformation
-
Information about the entity that processes payments for the billing plan.
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 —setSuccessorPlans()
Sets successor_plans
public
setSuccessorPlans(array<string|int, BillingPlan> $successor_plans) : $this
Parameters
- $successor_plans : array<string|int, BillingPlan>
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