Documentation

GetPlanOptions
in package

GetPlanOptions Class Doc Comment

Tags
category

Class

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

Table of Contents

$include_credit_card_information  : string|null
$include_credit_card_information When set to **true**, excludes credit card information from the response.
$include_downgrade_information  : string|null
$include_downgrade_information
$include_metadata  : string|null
$include_metadata When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information.
$include_successor_plans  : string|null
$include_successor_plans When set to **true**, excludes successor information from the response.
$include_tax_exempt_id  : string|null
$include_tax_exempt_id
getIncludeCreditCardInformation()  : string|null
Gets include_credit_card_information
getIncludeDowngradeInformation()  : string|null
Gets include_downgrade_information
getIncludeMetadata()  : string|null
Gets include_metadata
getIncludeSuccessorPlans()  : string|null
Gets include_successor_plans
getIncludeTaxExemptId()  : string|null
Gets include_tax_exempt_id
setIncludeCreditCardInformation()  : self
Sets include_credit_card_information
setIncludeDowngradeInformation()  : self
Sets include_downgrade_information
setIncludeMetadata()  : self
Sets include_metadata
setIncludeSuccessorPlans()  : self
Sets include_successor_plans
setIncludeTaxExemptId()  : self
Sets include_tax_exempt_id

Properties

$include_credit_card_information

$include_credit_card_information When set to **true**, excludes credit card information from the response.

protected string|null $include_credit_card_information = null

$include_downgrade_information

$include_downgrade_information

protected string|null $include_downgrade_information = null

$include_metadata

$include_metadata When set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information.

protected string|null $include_metadata = null

$include_successor_plans

$include_successor_plans When set to **true**, excludes successor information from the response.

protected string|null $include_successor_plans = null

$include_tax_exempt_id

$include_tax_exempt_id

protected string|null $include_tax_exempt_id = null

Methods

getIncludeCreditCardInformation()

Gets include_credit_card_information

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

getIncludeDowngradeInformation()

Gets include_downgrade_information

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

getIncludeMetadata()

Gets include_metadata

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

getIncludeSuccessorPlans()

Gets include_successor_plans

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

getIncludeTaxExemptId()

Gets include_tax_exempt_id

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

setIncludeCreditCardInformation()

Sets include_credit_card_information

public setIncludeCreditCardInformation(string|null $include_credit_card_information) : self
Parameters
$include_credit_card_information : string|null

When set to true, excludes credit card information from the response.

Return values
self —

setIncludeDowngradeInformation()

Sets include_downgrade_information

public setIncludeDowngradeInformation(string|null $include_downgrade_information) : self
Parameters
$include_downgrade_information : string|null
Return values
self —

setIncludeMetadata()

Sets include_metadata

public setIncludeMetadata(string|null $include_metadata) : self
Parameters
$include_metadata : string|null

When set to true, the canUpgrade and renewalStatus properities are included the response and an array of supportedCountries property is added to the billingAddress information.

Return values
self —

setIncludeSuccessorPlans()

Sets include_successor_plans

public setIncludeSuccessorPlans(string|null $include_successor_plans) : self
Parameters
$include_successor_plans : string|null

When set to true, excludes successor information from the response.

Return values
self —

setIncludeTaxExemptId()

Sets include_tax_exempt_id

public setIncludeTaxExemptId(string|null $include_tax_exempt_id) : self
Parameters
$include_tax_exempt_id : string|null
Return values
self —

Search results