--- title: "Updates an account billing plan." method: PUT path: "/v2.1/accounts/{accountId}/billing_plan" tags: ["BillingPlans"] --- # Updates an account billing plan. `PUT /v2.1/accounts/{accountId}/billing_plan` ## Request - Base URL: `https://www.docusign.net/restapi` - URL: `https://www.docusign.net/restapi/v2.1/accounts/{accountId}/billing_plan` - Auth: none declared Updates the billing plan information, billing address, and credit card information for the specified account. ## Path parameters - `accountId` string, required ## Query parameters - `preview_billing_plan` string ## Request body - BillingPlanInformation: This object contains details about a billing plan. - `appStoreReceipt` AppStoreReceipt: Contains information about an APP store receipt. - `downgradeProductId` string - `isDowngradeCancellation` string - `productId` string: The Product ID from the AppStore. - `receiptData` string: Reserved for Docusign. - `billingAddress` AccountAddress: Contains information about the address associated with the account. - `address1` string: The first line of the address. Maximum length: 100 characters. - `address2` string: The second line of the address. Maximum length: 100 characters. - `city` string: The city associated with the address. Maximum length: 40 characters. - `country` string: The country associated with the address. Maximum length: 50 characters. - `email` string: The email address associated with the account. - `fax` string: The fax number associated with the account. - `firstName` string: The first name of the user associated with the account. Maximum Length: 50 characters. - `lastName` string: The last name of the user associated with the account. - `phone` string: The phone number associated with the account. - `postalCode` string: The postal code associated with the address. Maximum length: 20 characters. - `state` string: The state or province associated with the address. Maximum length: 40 characters. - `supportedCountries` Country[]: An array of supported countries associated with the account. - `isoCode` string - `name` string - `provinces` Province[] - `isoCode` string - `name` string - `provinceValidated` string - `creditCardInformation` CreditCardInformation: This object contains information about a credit card that is associated with an account. - `address` AddressInformation: Contains address information. - `address1` string: The first line of the user's address. Maximum length: 100 characters. - `address2` string: The second line of the user's address. Maximum length: 100 characters. - `city` string: The user's city. Maximum length: 40 characters. - `country` string: The user's country. Maximum length: 50 characters. - `fax` string: A fax number associated with the address, if one is available. - `phone` string: A phone number associated with the address. - `postalCode` string: The user's postal code. Maximum length: 20 characters. - `stateOrProvince` string: The user's state or province. Maximum length: 40 characters. - `zipPlus4` string - `cardLastDigits` string - `cardNumber` string: The credit card number. - `cardType` string: The type of credit card. Valid values are: - `visa` - `mastercard` - `amex` - `cvNumber` string: The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs). - `expirationMonth` string: The month that the credit card expires, expressed as a number from 1 to 12. - `expirationYear` string: The year in which the credit card expires, in 4-digit format. - `nameOnCard` string: The exact name as it appears on the credit card. - `tokenizedCard` string - `directDebitProcessorInformation` DirectDebitProcessorInformation: Contains information about a bank that processes a customer's direct debit payments. - `bankBranchCode` string: The branch code of the bank used for direct debit. Maximum Length: 10 characters. - `bankCheckDigit` string: The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account. Maximum Length: 4 characters. - `bankCode` string: The code or number that identifies the bank. This is also known as the sort code. Example: `200000` Maximum Length: 18 characters. - `bankName` string: The name of the direct debit bank. Maximum Length: 80 characters. - `bankTransferAccountName` string: The name on the direct debit bank account. This field is required for POST and PUT requests. Maximum Length: 60 characters. - `bankTransferAccountNumber` string: The customer's bank account number. This value will be obfuscated. This field is required for POST and PUT requests. Maximum Length: 30 characters. - `bankTransferType` string: Specifies the type of direct debit transfer. The value of this field is dependent on the user's country. This field is required for POST and PUT requests. Possible values are: - `DirectDebitUK` - `DirectEntryAU` - `SEPA` - `country` string: The user's country. The system populates this value automatically. - `email` string: The email address of the user who is associated with the payment method. This field is required for POST and PUT requests. Maximum Length: 80 characters. - `firstName` string: The user's first name. This field is required for POST and PUT requests. Maximum Length: 30 characters. - `iBAN` string: The International Bank Account Number (IBAN). Example: `DE89370400440532013000` For more information, see [PeopleSoft's guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm). **Note:** This number will be obfuscated. - `lastName` string: The user's last name. This field is required for POST and PUT requests. Maximum Length: 70 characters. - `downgradeReason` string: (Optional) The user's reason for downgrading their billing plan. - `enablePreAuth` string - `enableSupport` string: When **true,** customer support is provided as part of the account plan. - `includedSeats` string: The number of seats (users) included in the plan. - `incrementalSeats` string: Reserved for Docusign. - `paymentMethod` string: The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` - `paymentProcessor` string - `paymentProcessorInformation` PaymentProcessorInformation - `address` AddressInformation: Contains address information. - `address1` string: The first line of the user's address. Maximum length: 100 characters. - `address2` string: The second line of the user's address. Maximum length: 100 characters. - `city` string: The user's city. Maximum length: 40 characters. - `country` string: The user's country. Maximum length: 50 characters. - `fax` string: A fax number associated with the address, if one is available. - `phone` string: A phone number associated with the address. - `postalCode` string: The user's postal code. Maximum length: 20 characters. - `stateOrProvince` string: The user's state or province. Maximum length: 40 characters. - `zipPlus4` string - `billingAgreementId` string: The ID of the billing agreement. - `email` string: The email address associated with the payment processor. - `planInformation` PlanInformation: An object used to identify the features and attributes of the account being created. - `addOns` AddOn[]: Reserved for Docusign. - `active` string: Reserved for Docusign. - `addOnId` string: Reserved for Docusign. - `id` string: A unique ID for the Salesforce object. - `name` string: Reserved for Docusign. - `currencyCode` string: Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. - `freeTrialDaysOverride` string: Reserved for Docusign. - `planFeatureSets` FeatureSet[]: Reserved for Docusign. - `currencyFeatureSetPrices` CurrencyFeatureSetPrice[]: Reserved for Docusign. - `currencyCode` string: Specifies the alternate ISO currency code for the account. - `currencySymbol` string: Reserved for Docusign. - `envelopeFee` string: Reserved for Docusign. - `fixedFee` string: Reserved for Docusign. - `seatFee` string: Reserved for Docusign. - `envelopeFee` string: Reserved for Docusign. - `featureSetId` string: Reserved for Docusign. - `fixedFee` string: Reserved for Docusign. - `is21CFRPart11` string: Reserved for Docusign. - `isActive` string: Reserved for Docusign. - `isEnabled` string: When **true,** the feature set is actively enabled as part of the plan. - `name` string: Reserved for Docusign. - `seatFee` string: Reserved for Docusign. - `planId` string: Docusign's ID for the account plan. - `recipientDomains` RecipientDomain[] - `active` string - `domainCode` string - `domainName` string - `recipientDomainId` string - `processPayment` string - `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 Docusign 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 Docusign use only. - `enableSupport` string: When **true,** customer support is provided as part of the account plan. - `externalOrgId` string: An optional external ID for the referral. - `groupMemberId` string - `idType` string - `includedSeats` string: The number of seats (users) included in the plan. - `industry` string: The name of the industry associated with the referral. Example: `Accounting` - `planStartMonth` string - `promoCode` string - `publisherId` string - `referralCode` string - `referrerName` string: The name of the referrer. - `saleDiscountAmount` string: Reserved for Docusign. - `saleDiscountFixedAmount` string: Reserved for Docusign. - `saleDiscountPercent` string: Reserved for Docusign. - `saleDiscountPeriods` string: Reserved for Docusign. - `saleDiscountSeatPriceOverride` string: Reserved for Docusign. - `shopperId` string - `renewalStatus` string: The renewal status of the account. Possible values are: - `auto`: The account automatically renews. - `queued_for_close`: The account will be closed at the billingPeriodEndDate. - queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`. - `saleDiscountAmount` string: Reserved for Docusign. - `saleDiscountFixedAmount` string: Reserved for Docusign. - `saleDiscountPercent` string: Reserved for Docusign. - `saleDiscountPeriods` string: Reserved for Docusign. - `saleDiscountSeatPriceOverride` string: Reserved for Docusign. - `taxExemptId` string ## Response `200` Successful response. ## Other responses - `400`: Error encountered. --- [API](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api.md) - [All operations](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/docusign/apis/docusign-esignature-rest-api/revisions/77f1998c313d?raw)