BillingPlans: getAccountPlan

Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.

By default the successor plan and credit card information is included in the response. This information can be excluded from the response by adding the appropriate optional query string with the setting set to false.

Response

The response returns the billing plan information, including the currency code, for the plan. The billingPlan and succesorPlans property values are the same as those shown in the [ML:Get Billing Plan Details] reference. the billingAddress and creditCardInformation property values are the same as those shown in the [ML:Update Billing Plan] reference.

Note: When credit card number information is shown, a mask is applied to the response so that only the last 4 digits of the card number are visible.

Request

HTTP request

GET /v2/accounts/{accountId}/billing_plan

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

Optional query parameters
include_credit_card_information string

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

include_metadata string

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

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

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Billing::getPlan

Definitions Expand All | Collapse All

BillingPlans

Billing plans

billingAddress accountAddress

The Billing address for the account.

billingAddressIsCreditCardAddress string

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.

billingPlan accountBillingPlan
creditCardInformation creditCardInformation

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

paymentProcessorInformation paymentProcessorInformation
referralInformation referralInformation

Contains information describing discounts and promotions.

successorPlans
[billingPlan]

accountAddress

Contains information about an account address.

address1 string

First Line of the address. Maximum length: 100 characters.

address2 string

Second Line of the address. Maximum length: 100 characters.

city string

The city value of the address.

country string

Specifies the country associated with the address.

email string
fax string
firstName string

The user's first name. Maximum Length: 50 characters.

lastName string
phone string
postalCode string
state string

The state or province associated with the address.

supportedCountries
[country]

Contains an array of countries supported by the billing plan.

accountBillingPlan

Contains information about an account billing plan.

addOns
[addOn]

Reserved:

canCancelRenewal string

Reserved: TBD

canUpgrade string

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

currencyCode string

Specifies the ISO currency code for the account.

enableSupport string

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

includedSeats string

The number of seats (users) included.

incrementalSeats string

Reserved: TBD

isDowngrade string
otherDiscountPercent string

Any other percentage discount for the plan.

paymentCycle string
paymentMethod string

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

perSeatPrice string
planClassification string

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

planFeatureSets
[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).
planId string

The DocuSign Plan ID for the account.

planName string

The name of the Billing Plan.

renewalStatus string

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.
seatDiscounts
[seatDiscount]

A complex type that contains any seat discount information.

Values are: BeginSeatCount, EndSeatCount, and SeatDiscountPercent.

supportIncidentFee string

The support incident fee charged for each support incident.

supportPlanFee string

The support plan fee charged for this plan.

addOn

Contains information about add ons.

active string

Reserved:

addOnId string

Reserved:

id string
name string

Reserved:

addressInformation

Contains address information.

city string

The city associated with the address.

country string

Specifies the country associated with the address.

fax string

A Fax number associated with the address if one is available.

phone string

A phone number associated with the address.

state string

The state or province associated with the address.

street1 string

The first line of the address.

street2 string

The second line of the address (optional).

zip string

The zip or postal code associated with the address.

appStoreProduct

Contains information about an APP store product.

marketPlace string
productId string

The Product ID from the AppStore.

billingPlan

Contains information about a billing plan.

appStoreProducts
[appStoreProduct]

Reserved: TBD

currencyPlanPrices
[currencyPlanPrice]

Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.

enableSupport string

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

includedSeats string

The number of seats (users) included.

otherDiscountPercent string
paymentCycle string

The payment cycle associated with the plan. The possible values are: Monthly or Annually.

paymentMethod string
perSeatPrice string

The per seat price for the plan.

planClassification string

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

planFeatureSets
[featureSet]

A complex type that sets the feature sets for the account.

planId string

The DocuSign Plan ID for the account.

planName string

The name of the Billing Plan.

seatDiscounts
[seatDiscount]
supportIncidentFee string

The support incident fee charged for each support incident.

supportPlanFee string

The support plan fee charged for this plan.

country

isoCode string
name string
provinces
[province]
provinceValidated string

creditCardInformation

address addressInformation

A complex element containing the credit card billing address information.

This can be the same as billing address and follows the same rules as billingAddress. It contains the following elements: street1, street2, city, state, zip, zipPlus4, phone, fax, and country.

cardNumber string

The number on the credit card.

cardType string

The credit card type. Valid values are: visa, mastercard, or amex.

expirationMonth string

The month that the credit card expires (1-12).

expirationYear string

The year 4 digit year in which the credit card expires.

nameOnCard string

The exact name printed on the credit card.

creditCardTypes

cardTypes
[string]

An array containing supported credit card types.

currencyFeatureSetPrice

currencyCode string

Specifies the alternate ISO currency code for the account.

currencySymbol string

Specifies the alternate currency symbol for the account.

envelopeFee string

An incremental envelope cost for plans with envelope overages (when isEnabled is set to true.)

fixedFee string

Specifies a one-time fee associated with the plan (when isEnabled is set to true.)

seatFee string

Specifies an incremental seat cost for seat-based plans (when isEnabled is set to true.)

currencyPlanPrice

currencyCode string

Specifies the ISO currency code for the account.

currencySymbol string

Specifies the currency symbol for the account.

perSeatPrice string
supportedCardTypes creditCardTypes

A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).

supportIncidentFee string

The support incident fee charged for each support incident.

supportPlanFee string

The support plan fee charged for this plan.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

featureSet

currencyFeatureSetPrices
[currencyFeatureSetPrice]

A complex type that contains alternate currency values that are configured for this plan feature set.

envelopeFee string
featureSetId string

A unique ID for the feature set.

fixedFee string
is21CFRPart11 string

When set to true, indicates that this module is enabled on the account.

isActive string
isEnabled string

Specifies whether the feature set is actively enabled as part of the plan.

name string
seatFee string

An incremental seat cost for seat-based plans. Only valid when isEnabled for the feature set is set to true.

paymentProcessorInformation

address addressInformation
billingAgreementId string
email string

province

isoCode string
name string

referralInformation

A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry

Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.
advertisementId string

A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry.

Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only.
enableSupport string

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

externalOrgId string
groupMemberId string
idType string
includedSeats string

The number of seats (users) included.

industry string
planStartMonth string
promoCode string
publisherId string
referralCode string
referrerName string
saleDiscountAmount string

Reserved for DocuSign use only.

saleDiscountFixedAmount string

Reserved for DocuSign use only.

saleDiscountPercent string

Reserved for DocuSign use only.

saleDiscountPeriods string

Reserved for DocuSign use only.

saleDiscountSeatPriceOverride string

Reserved for DocuSign use only.

shopperId string

seatDiscount

beginSeatCount string

Reserved: TBD

discountPercent string
endSeatCount string

Reserved: TBD

Examples

Generic JSON Response

Response

{
"billingPlan": {
"planId": "sample string 1",
"planName": "sample string 2",
"paymentCycle": "sample string 3",
"paymentMethod": "sample string 4",
"perSeatPrice": "sample string 5",
"otherDiscountPercent": "sample string 6",
"supportIncidentFee": "sample string 7",
"supportPlanFee": "sample string 8",
"includedSeats": "sample string 9",
"incrementalSeats": "sample string 10",
"enableSupport": "sample string 11",
"currencyCode": "sample string 12",
"canUpgrade": "sample string 13",
"canCancelRenewal": "sample string 14",
"renewalStatus": "sample string 15",
"isDowngrade": "sample string 16",
"planClassification": "sample string 17",
"seatDiscounts": [
{
"beginSeatCount": "sample string 1",
"endSeatCount": "sample string 2",
"discountPercent": "sample string 3"
}
]
,
"planFeatureSets": [
{
"featureSetId": "sample string 1",
"isActive": "sample string 2",
"name": "sample string 3",
"fixedFee": "sample string 4",
"envelopeFee": "sample string 5",
"seatFee": "sample string 6",
"isEnabled": "sample string 7",
"is21CFRPart11": "sample string 8",
"currencyFeatureSetPrices": [
{
"currencyCode": "sample string 1",
"fixedFee": "sample string 2",
"seatFee": "sample string 3",
"envelopeFee": "sample string 4",
"currencySymbol": "sample string 5"
}
]
}
]
,
"addOns": [
{
"id": "sample string 1",
"addOnId": "sample string 2",
"name": "sample string 3",
"active": "sample string 4"
}
]
}
,
"successorPlans": [
{
"planName": "sample string 1",
"paymentCycle": "sample string 2",
"paymentMethod": "sample string 3",
"planClassification": "sample string 4",
"perSeatPrice": "sample string 5",
"otherDiscountPercent": "sample string 6",
"supportIncidentFee": "sample string 7",
"supportPlanFee": "sample string 8",
"includedSeats": "sample string 9",
"enableSupport": "sample string 10",
"planId": "sample string 11",
"seatDiscounts": [
{}
]
,
"planFeatureSets": [
{}
]
,
"currencyPlanPrices": [
{
"currencyCode": "sample string 1",
"perSeatPrice": "sample string 2",
"supportIncidentFee": "sample string 3",
"supportPlanFee": "sample string 4",
"currencySymbol": "sample string 5",
"supportedCardTypes": {
"cardTypes": [
"sample string 1"
]
}
}
]
,
"appStoreProducts": [
{
"productId": "sample string 1",
"marketPlace": "sample string 2"
}
]
}
]
,
"billingAddress": {
"address1": "sample string 1",
"address2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"postalCode": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8",
"firstName": "sample string 9",
"lastName": "sample string 10",
"email": "sample string 11",
"supportedCountries": [
{
"isoCode": "sample string 1",
"provinceValidated": "sample string 2",
"name": "sample string 3",
"provinces": [
{
"isoCode": "sample string 1",
"name": "sample string 2"
}
]
}
]
}
,
"billingAddressIsCreditCardAddress": "sample string 1",
"creditCardInformation": {
"cardNumber": "sample string 1",
"expirationMonth": "sample string 2",
"expirationYear": "sample string 3",
"nameOnCard": "sample string 4",
"cardType": "sample string 5",
"address": {
"street1": "sample string 1",
"street2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"zip": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8"
}
}
,
"paymentProcessorInformation": {
"billingAgreementId": "sample string 1",
"email": "sample string 2",
"address": {}
}
,
"referralInformation": {
"enableSupport": "sample string 1",
"includedSeats": "sample string 2",
"saleDiscountPercent": "sample string 3",
"saleDiscountAmount": "sample string 4",
"saleDiscountFixedAmount": "sample string 5",
"saleDiscountPeriods": "sample string 6",
"saleDiscountSeatPriceOverride": "sample string 7",
"planStartMonth": "sample string 8",
"referralCode": "sample string 9",
"referrerName": "sample string 10",
"advertisementId": "sample string 11",
"publisherId": "sample string 12",
"shopperId": "sample string 13",
"promoCode": "sample string 14",
"groupMemberId": "sample string 15",
"idType": "sample string 16",
"industry": "sample string 17",
"externalOrgId": "sample string 18"
}
}

Generic XML Response

Response

<accountBillingPlanResponse 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<billingAddress>
<address1>sample string 1</address1>
<address2>sample string 2</address2>
<city>sample string 3</city>
<country>sample string 8</country>
<email>sample string 11</email>
<fax>sample string 7</fax>
<firstName>sample string 9</firstName>
<lastName>sample string 10</lastName>
<phone>sample string 6</phone>
<postalCode>sample string 5</postalCode>
<state>sample string 4</state>
<supportedCountries>
<country>
<isoCode>sample string 1</isoCode>
<name>sample string 3</name>
<provinceValidated>sample string 2</provinceValidated>
<provinces>
<province>
<isoCode>sample string 1</isoCode>
<name>sample string 2</name>
</province>
</provinces>
</country>
</supportedCountries>
</billingAddress>
<billingAddressIsCreditCardAddress>sample string 1</billingAddressIsCreditCardAddress>
<billingPlan>
<addOns>
<addOn>
<active>sample string 4</active>
<addOnId>sample string 2</addOnId>
<id>sample string 1</id>
<name>sample string 3</name>
</addOn>
</addOns>
<canCancelRenewal>sample string 14</canCancelRenewal>
<canUpgrade>sample string 13</canUpgrade>
<currencyCode>sample string 12</currencyCode>
<enableSupport>sample string 11</enableSupport>
<includedSeats>sample string 9</includedSeats>
<incrementalSeats>sample string 10</incrementalSeats>
<isDowngrade>sample string 16</isDowngrade>
<otherDiscountPercent>sample string 6</otherDiscountPercent>
<paymentCycle>sample string 3</paymentCycle>
<paymentMethod>sample string 4</paymentMethod>
<perSeatPrice>sample string 5</perSeatPrice>
<planClassification>sample string 17</planClassification>
<planFeatureSets>
<featureSet>
<currencyFeatureSetPrices>
<currencyFeatureSetPrice>
<currencyCode>sample string 1</currencyCode>
<currencySymbol>sample string 5</currencySymbol>
<envelopeFee>sample string 4</envelopeFee>
<fixedFee>sample string 2</fixedFee>
<seatFee>sample string 3</seatFee>
</currencyFeatureSetPrice>
</currencyFeatureSetPrices>
<envelopeFee>sample string 5</envelopeFee>
<featureSetId>sample string 1</featureSetId>
<fixedFee>sample string 4</fixedFee>
<is21CFRPart11>sample string 8</is21CFRPart11>
<isActive>sample string 2</isActive>
<isEnabled>sample string 7</isEnabled>
<name>sample string 3</name>
<seatFee>sample string 6</seatFee>
</featureSet>
</planFeatureSets>
<planId>sample string 1</planId>
<planName>sample string 2</planName>
<renewalStatus>sample string 15</renewalStatus>
<seatDiscounts>
<seatDiscount>
<beginSeatCount>sample string 1</beginSeatCount>
<discountPercent>sample string 3</discountPercent>
<endSeatCount>sample string 2</endSeatCount>
</seatDiscount>
</seatDiscounts>
<supportIncidentFee>sample string 7</supportIncidentFee>
<supportPlanFee>sample string 8</supportPlanFee>
</billingPlan>
<creditCardInformation>
<address>
<city>sample string 3</city>
<country>sample string 8</country>
<fax>sample string 7</fax>
<phone>sample string 6</phone>
<state>sample string 4</state>
<street1>sample string 1</street1>
<street2>sample string 2</street2>
<zip>sample string 5</zip>
</address>
<cardNumber>sample string 1</cardNumber>
<cardType>sample string 5</cardType>
<expirationMonth>sample string 2</expirationMonth>
<expirationYear>sample string 3</expirationYear>
<nameOnCard>sample string 4</nameOnCard>
</creditCardInformation>
<paymentProcessorInformation
xmlns:d2p1="http://schemas.datacontract.org/2004/07/API_REST.Models.v2">

<d2p1:address />
<d2p1:billingAgreementId>sample string 1</d2p1:billingAgreementId>
<d2p1:email>sample string 2</d2p1:email>
</paymentProcessorInformation>
<referralInformation>
<advertisementId>sample string 11</advertisementId>
<enableSupport>sample string 1</enableSupport>
<externalOrgId>sample string 18</externalOrgId>
<groupMemberId>sample string 15</groupMemberId>
<idType>sample string 16</idType>
<includedSeats>sample string 2</includedSeats>
<industry>sample string 17</industry>
<planStartMonth>sample string 8</planStartMonth>
<promoCode>sample string 14</promoCode>
<publisherId>sample string 12</publisherId>
<referralCode>sample string 9</referralCode>
<referrerName>sample string 10</referrerName>
<saleDiscountAmount>sample string 4</saleDiscountAmount>
<saleDiscountFixedAmount>sample string 5</saleDiscountFixedAmount>
<saleDiscountPercent>sample string 3</saleDiscountPercent>
<saleDiscountPeriods>sample string 6</saleDiscountPeriods>
<saleDiscountSeatPriceOverride>sample string 7</saleDiscountSeatPriceOverride>
<shopperId>sample string 13</shopperId>
</referralInformation>
<successorPlans>
<billingPlan>
<appStoreProducts>
<appStoreProduct>
<marketPlace>sample string 2</marketPlace>
<productId>sample string 1</productId>
</appStoreProduct>
</appStoreProducts>
<currencyPlanPrices>
<currencyPlanPrice>
<currencyCode>sample string 1</currencyCode>
<currencySymbol>sample string 5</currencySymbol>
<perSeatPrice>sample string 2</perSeatPrice>
<supportIncidentFee>sample string 3</supportIncidentFee>
<supportPlanFee>sample string 4</supportPlanFee>
<supportedCardTypes>
<cardTypes>
<string>sample string 1</string>
</cardTypes>
</supportedCardTypes>
</currencyPlanPrice>
</currencyPlanPrices>
<enableSupport>sample string 10</enableSupport>
<includedSeats>sample string 9</includedSeats>
<otherDiscountPercent>sample string 6</otherDiscountPercent>
<paymentCycle>sample string 2</paymentCycle>
<paymentMethod>sample string 3</paymentMethod>
<perSeatPrice>sample string 5</perSeatPrice>
<planClassification>sample string 4</planClassification>
<planFeatureSets>
<featureSet />
</planFeatureSets>
<planId>sample string 11</planId>
<planName>sample string 1</planName>
<seatDiscounts>
<seatDiscount />
</seatDiscounts>
<supportIncidentFee>sample string 7</supportIncidentFee>
<supportPlanFee>sample string 8</supportPlanFee>
</billingPlan>
</successorPlans>
</accountBillingPlanResponse>