Skip to content

DocuSign: Updates an account billing plan

DocuSign esignature.esignatureBillingPlanPutBillingPlan: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_billingplan_putbillingplan

Provider route: PUT /restapi/v2.1/accounts/{accountId}/billing_plan. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureBillingPlanPutBillingPlan"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureBillingPlanPutBillingPlan(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_billing_plan_put_billing_plan(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.preview_billing_planstringOptional
bodyModelOptionalExpand Updates an account billing plan — request body — body

Referenced models: Updates an account billing plan — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Updates an account billing plan — response body

Referenced models: Updates an account billing plan — response body

13 more schemas are linked from the tables above, on the schema pages.

Updates an account billing plan — response body
FieldTypePresenceDescription and constraints
$objectRootDefines a billing plan update response object.
accountPaymentMethodstringOptionalThe type of payment method used for the account. Valid values are:

- `credit_card`
-
billingPlanPreviewModelOptionalExpand Updates an account billing plan — response body — billing Plan Preview
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
includedSeatsstringOptionalThe number of seats (users) included in the plan.
paymentCyclestringOptionalThe payment cycle associated with the plan. Valid values:

- `Monthly`
- `Annually`
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
planIdstringOptionalDocusign's ID for the account plan.
planNamestringOptionalThe name of the billing plan used for the account.

Examples:

- `Personal - Annual`
- `Unlimited Envelope Subscription - Annual Billing`

Referenced models: Updates an account billing plan — response body — billing Plan Preview

Updates an account billing plan — request body — body
FieldTypePresenceDescription and constraints
$objectRootThis object contains details about a billing plan.
appStoreReceiptModelOptionalExpand Updates an account billing plan — request body — body app Store Receipt
billingAddressModelOptionalExpand Get Account Billing Plan — response body — billing Address
The billing address for the account.
creditCardInformationModelOptionalExpand Get credit card information — response body
A complex type that has information about the credit card used to pay for this account.
directDebitProcessorInformationModelOptionalExpand Get Account Billing Plan — response body — direct Debit Processor Information
Information about the bank that processes direct debits for the payment plan.
downgradeReasonstringOptional(Optional) The user's reason for downgrading their billing plan.
enablePreAuthstringOptional
enableSupportstringOptionalWhen **true,** customer support is provided as part of the account plan.
includedSeatsstringOptionalThe number of seats (users) included in the plan.
incrementalSeatsstringOptionalReserved for Docusign.
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
paymentProcessorstringOptional
paymentProcessorInformationModelOptionalExpand Get Account Billing Plan — response body — payment Processor Information
Information about the entity that processes payments for the billing plan.
planInformationModelOptionalExpand Updates an account billing plan — request body — body plan Information
An object used to identify the features and attributes of the account being created.
processPaymentstringOptional
referralInformationModelOptionalExpand Get Account Billing Plan — response body — referral Information
A complex type that contains properties for entering referral and discount information.
renewalStatusstringOptionalThe 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`.
saleDiscountAmountstringOptionalReserved for Docusign.
saleDiscountFixedAmountstringOptionalReserved for Docusign.
saleDiscountPercentstringOptionalReserved for Docusign.
saleDiscountPeriodsstringOptionalReserved for Docusign.
saleDiscountSeatPriceOverridestringOptionalReserved for Docusign.
taxExemptIdstringOptional

Referenced models: Get Account Billing Plan — response body — billing Address, Get credit card information — response body, Get Account Billing Plan — response body — direct Debit Processor Information, Get Account Billing Plan — response body — payment Processor Information, Get Account Billing Plan — response body — referral Information, Updates an account billing plan — request body — body app Store Receipt, Updates an account billing plan — request body — body plan Information

Updates an account billing plan — response body — billing Plan Preview
FieldTypePresenceDescription and constraints
$objectRootInformation used to provide a preview of a billing plan.
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
invoiceModelOptionalExpand Retrieves a billing invoice — response body
isProratedstringOptionalWhen **true,** the billing plan is prorated.
subtotalAmountstringOptional
taxAmountstringOptional
totalAmountstringOptional

Referenced models: Retrieves a billing invoice — response body

Get Account Billing Plan — response body — billing Address
FieldTypePresenceDescription and constraints
$objectRootContains information about the address associated with the account.
address1stringOptionalThe first line of the address. Maximum length: 100 characters.
address2stringOptionalThe second line of the address. Maximum length: 100 characters.
citystringOptionalThe city associated with the address. Maximum length: 40 characters.
countrystringOptionalThe country associated with the address. Maximum length: 50 characters.
emailstringOptionalThe email address associated with the account.
faxstringOptionalThe fax number associated with the account.
firstNamestringOptionalThe first name of the user associated with the account. Maximum Length: 50 characters.
lastNamestringOptionalThe last name of the user associated with the account.
phonestringOptionalThe phone number associated with the account.
postalCodestringOptionalThe postal code associated with the address. Maximum length: 20 characters.
statestringOptionalThe state or province associated with the address. Maximum length: 40 characters.
supportedCountriesarrayOptionalAn array of supported countries associated with the account.
supportedCountries[]ModelEach itemExpand Get Account Billing Plan — response body — billing Address supported Countries item

Referenced models: Get Account Billing Plan — response body — billing Address supported Countries item

Get credit card information — response body
FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a credit card that is associated with an account.
addressModelOptionalExpand Get credit card information — response body — address
A complex element containing the credit card billing address information.
cardLastDigitsstringOptional
cardNumberstringOptionalThe credit card number.
cardTypestringOptionalThe type of credit card. Valid values are:

- `visa`
- `mastercard`
- `amex`
cvNumberstringOptionalThe 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).
expirationMonthstringOptionalThe month that the credit card expires, expressed as a number from 1 to 12.
expirationYearstringOptionalThe year in which the credit card expires, in 4-digit format.
nameOnCardstringOptionalThe exact name as it appears on the credit card.
tokenizedCardstringOptional

Referenced models: Get credit card information — response body — address

Get Account Billing Plan — response body — payment Processor Information
FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Get credit card information — response body — address
The mailing address associated with the payment processor.
billingAgreementIdstringOptionalThe ID of the billing agreement.
emailstringOptionalThe email address associated with the payment processor.

Referenced models: Get credit card information — response body — address

SDK function policy ID: docusign.esignature_billingplan_putbillingplan. Catalog operation: esignature:BillingPlan_PutBillingPlan. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.