BillingPlans: update

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

Request

HTTP request

PUT /v2.1/accounts/{accountId}/billing_plan

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
preview_billing_planstring

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

Responses

CodeDescriptionReference
200

Successful response.

billingPlanUpdateResponse
400

Error encountered.

errorDetails

SDK Method

Billing::updatePlan

Definitions

accountAddress

Contains information about an account address.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The city value of the address.

countrystring

Specifies the country associated with the address.

emailstring

Filters returned user records by the specified email address.

faxstring

firstNamestring

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

lastNamestring

phonestring

postalCodestring

The postal code associated with the address.

statestring

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.

activestring

Reserved:

addOnIdstring

Reserved:

idstring

A unique ID for the Salesforce object.

namestring

Reserved:

addressInformation

Contains address information.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The user's city.

countrystring

The user's country.

faxstring

A fax number associated with the address, if one is available.

phonestring

A phone number associated with the address.

postalCodestring

The user's postal code.

stateOrProvincestring

The user's state or province.

appStoreReceipt

Contains information about an APP store receipt.

productIdstring

The Product ID from the AppStore.

receiptDatastring

Reserved: TBD

billingInvoiceItem

Contains information about an item on a billing invoice.

chargeAmountstring

Reserved: TBD

chargeNamestring

Reserved: TBD

invoiceItemIdstring

Reserved: TBD

quantitystring

The quantity of envelopes to add to the account.

unitPricestring

Reserved: TBD

billingPlanInformation

appStoreReceiptappStoreReceipt

billingAddressaccountAddress

The billing address for the account.

creditCardInformationcreditCardInformation

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

directDebitProcessorInformationdirectDebitProcessorInformation

Information about the bank that processes direct debits for the payment plan.

downgradeReasonstring

enableSupportstring

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

includedSeatsstring

The number of seats (users) included.

incrementalSeatsstring

Reserved for DocuSign.

paymentMethodstring

The payment method used for the billing plan. Valid values are:

  • NotSupported
  • CreditCard
  • PurchaseOrder
  • Premium
  • Freemium
  • FreeTrial
  • AppStore
  • DigitalExternal
  • DirectDebit

paymentProcessorInformationpaymentProcessorInformation

Information about the entity that processes payments for the billing plan.

planInformationplanInformation

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

referralInformationreferralInformation

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.

renewalStatusstring

saleDiscountAmountstring

Reserved for DocuSign use only.

saleDiscountFixedAmountstring

Reserved for DocuSign use only.

saleDiscountPercentstring

Reserved for DocuSign use only.

saleDiscountPeriodsstring

Reserved for DocuSign use only.

saleDiscountSeatPriceOverridestring

Reserved for DocuSign use only.

billingPlanPreview

Contains information about a preview billing plan.

currencyCodestring

Specifies the ISO currency code for the account.

invoiceInvoices

isProratedstring

subtotalAmountstring

taxAmountstring

totalAmountstring

billingPlanUpdateResponse

Defines a billing plan update response object.

accountPaymentMethodstring

billingPlanPreviewbillingPlanPreview

currencyCodestring

Specifies the ISO currency code for the account.

includedSeatsstring

The number of seats (users) included.

paymentCyclestring

paymentMethodstring

The payment method used for the billing plan. Valid values are:

  • NotSupported
  • CreditCard
  • PurchaseOrder
  • Premium
  • Freemium
  • FreeTrial
  • AppStore
  • DigitalExternal
  • DirectDebit

planIdstring

The DocuSign plan id for the account.

planNamestring

The name of the billing plan used for the account.

country

isoCodestring

namestring

provinces[province]

provinceValidatedstring

creditCardInformation

addressaddressInformation

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.

cardNumberstring

The number on the credit card.

cardTypestring

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

cvNumberstring

expirationMonthstring

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

expirationYearstring

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

nameOnCardstring

The exact name printed on the credit card.

currencyFeatureSetPrice

currencyCodestring

Specifies the alternate ISO currency code for the account.

currencySymbolstring

Specifies the alternate currency symbol for the account.

envelopeFeestring

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

fixedFeestring

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

seatFeestring

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

directDebitProcessorInformation

bankBranchCodestring

bankCheckDigitstring

bankCodestring

bankNamestring

bankTransferAccountNamestring

bankTransferAccountNumberstring

bankTransferTypestring

countrystring

Specifies the country associated with the address.

emailstring

Filters returned user records by the specified email address.

firstNamestring

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

iBANstring

lastNamestring

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

featureSet

currencyFeatureSetPrices[currencyFeatureSetPrice]

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

envelopeFeestring

featureSetIdstring

A unique ID for the feature set.

fixedFeestring

is21CFRPart11string

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

isActivestring

Reserved for DocuSign.

isEnabledstring

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

namestring

The name of the feature set.

seatFeestring

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

paymentProcessorInformation

addressaddressInformation

The user's address.

billingAgreementIdstring

emailstring

Filters returned user records by the specified email address.

planInformation

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

addOns[addOn]

Reserved for DocuSign.

currencyCodestring

Specifies the ISO currency code for the account.

freeTrialDaysOverridestring

Reserved for DocuSign use only.

planFeatureSets[featureSet]

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

planIdstring

The DocuSign plan id for the account.

recipientDomains[recipientDomain]

province

isoCodestring

namestring

recipientDomain

activestring

domainCodestring

domainNamestring

recipientDomainIdstring

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.

advertisementIdstring

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.

enableSupportstring

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

externalOrgIdstring

groupMemberIdstring

idTypestring

includedSeatsstring

The number of seats (users) included.

industrystring

planStartMonthstring

promoCodestring

publisherIdstring

referralCodestring

referrerNamestring

saleDiscountAmountstring

Reserved for DocuSign use only.

saleDiscountFixedAmountstring

Reserved for DocuSign use only.

saleDiscountPercentstring

Reserved for DocuSign use only.

saleDiscountPeriodsstring

Reserved for DocuSign use only.

saleDiscountSeatPriceOverridestring

Reserved for DocuSign use only.

shopperIdstring

Invoices

Invoices

amountstring

Reserved: TBD

balancestring

Reserved: TBD

dueDatestring

Reserved: TBD

invoiceIdstring

Reserved: TBD

invoiceItems[billingInvoiceItem]

Reserved: TBD

invoiceNumberstring

Reserved: TBD

invoiceUristring

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

nonTaxableAmountstring

pdfAvailablestring

taxableAmountstring

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> 
}} />