Updates the billing plan information, billing address, and credit card information for the specified account.

Request

HTTP request

PUT /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
preview_billing_plan string

When set to true, updates the account using a preview billing plan.

Request Body

Responses

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

SDK Method

Billing::updatePlan

Definitions Expand All | Collapse All

Invoices

Invoices

amount string

Reserved: TBD

balance string

Reserved: TBD

dueDate string

Reserved: TBD

invoiceId string

Reserved: TBD

invoiceItems
[billingInvoiceItem]

Reserved: TBD

invoiceNumber string

Reserved: TBD

invoiceUri string

Contains a URI for an endpoint that you can use to retrieve invoice information.

nonTaxableAmount string
pdfAvailable string
taxableAmount string

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.

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.

appStoreReceipt

Contains information about an APP store receipt.

productId string

The Product ID from the AppStore.

receiptData string

Reserved: TBD

billingInvoiceItem

Contains information about an item on a billing invoice.

chargeAmount string

Reserved: TBD

chargeName string

Reserved: TBD

invoiceItemId string

Reserved: TBD

quantity string

The quantity of envelopes to add to the account.

unitPrice string

Reserved: TBD

billingPlanInformation

appStoreReceipt appStoreReceipt
billingAddress accountAddress
creditCardInformation creditCardInformation

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

downgradeReason string
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

paymentProcessorInformation paymentProcessorInformation
planInformation planInformation

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

referralInformation 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.
renewalStatus 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.

billingPlanPreview

Contains information about a preview billing plan.

currencyCode string

Specifies the ISO currency code for the account.

invoice Invoices
isProrated string
subtotalAmount string
taxAmount string
totalAmount string

billingPlanUpdateResponse

Defines a billing plan update response object.

accountPaymentMethod string
billingPlanPreview billingPlanPreview
currencyCode string

Specifies the ISO currency code for the account.

includedSeats string

The number of seats (users) included.

paymentCycle string
paymentMethod string
planId string

The DocuSign Plan ID for the account.

planName string

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.

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

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

planInformation

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

addOns
[addOn]

Reserved:

currencyCode string

Specifies the ISO currency code for the account.

freeTrialDaysOverride string

Reserved for DocuSign use only.

planFeatureSets
[featureSet]

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

planId string

The DocuSign Plan ID for the account.

recipientDomains
[recipientDomain]

province

isoCode string
name string

recipientDomain

active string
domainCode string
domainName string
recipientDomainId 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

Examples

Generic JSON Request/Response

Request

{
"planInformation": {
"planId": "sample string 1",
"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"
}
]
,
"recipientDomains": [
{
"recipientDomainId": "sample string 1",
"domainCode": "sample string 2",
"domainName": "sample string 3",
"active": "sample string 4"
}
]
,
"currencyCode": "sample string 2",
"freeTrialDaysOverride": "sample string 3"
}
,
"enableSupport": "sample string 1",
"includedSeats": "sample string 2",
"incrementalSeats": "sample string 3",
"saleDiscountPercent": "sample string 4",
"saleDiscountAmount": "sample string 5",
"saleDiscountFixedAmount": "sample string 6",
"saleDiscountPeriods": "sample string 7",
"saleDiscountSeatPriceOverride": "sample string 8",
"renewalStatus": "sample string 9",
"downgradeReason": "sample string 10",
"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"
}
}
,
"appStoreReceipt": {
"productId": "sample string 1",
"receiptData": "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"
}
]
}
]
}
,
"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"
}
,
"paymentProcessorInformation": {
"billingAgreementId": "sample string 1",
"email": "sample string 2",
"address": {}
}
}

Response

{
"planName": "sample string 1",
"planId": "sample string 2",
"paymentCycle": "sample string 3",
"paymentMethod": "sample string 4",
"accountPaymentMethod": "sample string 5",
"includedSeats": "sample string 6",
"currencyCode": "sample string 7",
"billingPlanPreview": {
"subtotalAmount": "sample string 1",
"taxAmount": "sample string 2",
"totalAmount": "sample string 3",
"isProrated": "sample string 4",
"currencyCode": "sample string 5",
"invoice": {
"amount": "sample string 1",
"taxableAmount": "sample string 2",
"nonTaxableAmount": "sample string 3",
"balance": "sample string 4",
"dueDate": "sample string 5",
"invoiceId": "sample string 6",
"invoiceNumber": "sample string 7",
"pdfAvailable": "sample string 8",
"invoiceUri": "sample string 9",
"invoiceItems": [
{
"chargeAmount": "sample string 1",
"chargeName": "sample string 2",
"invoiceItemId": "sample string 3",
"quantity": "sample string 4",
"unitPrice": "sample string 5"
}
]
}
}
}

Generic XML Request/Response

Request

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

<appStoreReceipt>
<productId>sample string 1</productId>
<receiptData>sample string 2</receiptData>
</appStoreReceipt>
<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>
<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>
<downgradeReason>sample string 10</downgradeReason>
<enableSupport>sample string 1</enableSupport>
<includedSeats>sample string 2</includedSeats>
<incrementalSeats>sample string 3</incrementalSeats>
<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>
<planInformation>
<addOns>
<addOn>
<active>sample string 4</active>
<addOnId>sample string 2</addOnId>
<id>sample string 1</id>
<name>sample string 3</name>
</addOn>
</addOns>
<currencyCode>sample string 2</currencyCode>
<freeTrialDaysOverride>sample string 3</freeTrialDaysOverride>
<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>
<recipientDomains>
<recipientDomain>
<active>sample string 4</active>
<domainCode>sample string 2</domainCode>
<domainName>sample string 3</domainName>
<recipientDomainId>sample string 1</recipientDomainId>
</recipientDomain>
</recipientDomains>
</planInformation>
<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>
<renewalStatus>sample string 9</renewalStatus>
<saleDiscountAmount>sample string 5</saleDiscountAmount>
<saleDiscountFixedAmount>sample string 6</saleDiscountFixedAmount>
<saleDiscountPercent>sample string 4</saleDiscountPercent>
<saleDiscountPeriods>sample string 7</saleDiscountPeriods>
<saleDiscountSeatPriceOverride>sample string 8</saleDiscountSeatPriceOverride>
</billingPlanInformation>

Response

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

<accountPaymentMethod>sample string 5</accountPaymentMethod>
<billingPlanPreview>
<currencyCode>sample string 5</currencyCode>
<invoice>
<amount>sample string 1</amount>
<balance>sample string 4</balance>
<dueDate>sample string 5</dueDate>
<invoiceId>sample string 6</invoiceId>
<invoiceItems>
<billingInvoiceItem>
<chargeAmount>sample string 1</chargeAmount>
<chargeName>sample string 2</chargeName>
<invoiceItemId>sample string 3</invoiceItemId>
<quantity>sample string 4</quantity>
<unitPrice>sample string 5</unitPrice>
</billingInvoiceItem>
</invoiceItems>
<invoiceNumber>sample string 7</invoiceNumber>
<invoiceUri>sample string 9</invoiceUri>
<nonTaxableAmount>sample string 3</nonTaxableAmount>
<pdfAvailable>sample string 8</pdfAvailable>
<taxableAmount>sample string 2</taxableAmount>
</invoice>
<isProrated>sample string 4</isProrated>
<subtotalAmount>sample string 1</subtotalAmount>
<taxAmount>sample string 2</taxAmount>
<totalAmount>sample string 3</totalAmount>
</billingPlanPreview>
<currencyCode>sample string 7</currencyCode>
<includedSeats>sample string 6</includedSeats>
<paymentCycle>sample string 3</paymentCycle>
<paymentMethod>sample string 4</paymentMethod>
<planId>sample string 2</planId>
<planName>sample string 1</planName>
</billingPlanUpdateResponse>