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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.preview_billing_plan | string | Optional | |
body | Model | Optional | Expand Updates an account billing plan — request body — body |
Referenced models: Updates an account billing plan — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Updates an account billing plan — response body |
Referenced models: Updates an account billing plan — response body
Schemas
Section titled “Schemas”13 more schemas are linked from the tables above, on the schema pages.
Updates an account billing plan — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing plan update response object. |
accountPaymentMethod | string | Optional | The type of payment method used for the account. Valid values are: - `credit_card` - |
billingPlanPreview | Model | Optional | Expand Updates an account billing plan — response body — billing Plan Preview |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
paymentCycle | string | Optional | The payment cycle associated with the plan. Valid values: - `Monthly` - `Annually` |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
planId | string | Optional | Docusign's ID for the account plan. |
planName | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a billing plan. |
appStoreReceipt | Model | Optional | Expand Updates an account billing plan — request body — body app Store Receipt |
billingAddress | Model | Optional | Expand Get Account Billing Plan — response body — billing Address The billing address for the account. |
creditCardInformation | Model | Optional | Expand Get credit card information — response body A complex type that has information about the credit card used to pay for this account. |
directDebitProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — direct Debit Processor Information Information about the bank that processes direct debits for the payment plan. |
downgradeReason | string | Optional | (Optional) The user's reason for downgrading their billing plan. |
enablePreAuth | string | Optional | |
enableSupport | string | Optional | When **true,** customer support is provided as part of the account plan. |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
incrementalSeats | string | Optional | Reserved for Docusign. |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
paymentProcessor | string | Optional | |
paymentProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — payment Processor Information Information about the entity that processes payments for the billing plan. |
planInformation | Model | Optional | Expand Updates an account billing plan — request body — body plan Information An object used to identify the features and attributes of the account being created. |
processPayment | string | Optional | |
referralInformation | Model | Optional | Expand Get Account Billing Plan — response body — referral Information A complex type that contains properties for entering referral and discount information. |
renewalStatus | string | Optional | 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 | Optional | Reserved for Docusign. |
saleDiscountFixedAmount | string | Optional | Reserved for Docusign. |
saleDiscountPercent | string | Optional | Reserved for Docusign. |
saleDiscountPeriods | string | Optional | Reserved for Docusign. |
saleDiscountSeatPriceOverride | string | Optional | Reserved for Docusign. |
taxExemptId | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information used to provide a preview of a billing plan. |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
invoice | Model | Optional | Expand Retrieves a billing invoice — response body |
isProrated | string | Optional | When **true,** the billing plan is prorated. |
subtotalAmount | string | Optional | |
taxAmount | string | Optional | |
totalAmount | string | Optional |
Referenced models: Retrieves a billing invoice — response body
Get Account Billing Plan — response body — billing Address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the address associated with the account. |
address1 | string | Optional | The first line of the address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the address. Maximum length: 100 characters. |
city | string | Optional | The city associated with the address. Maximum length: 40 characters. |
country | string | Optional | The country associated with the address. Maximum length: 50 characters. |
email | string | Optional | The email address associated with the account. |
fax | string | Optional | The fax number associated with the account. |
firstName | string | Optional | The first name of the user associated with the account. Maximum Length: 50 characters. |
lastName | string | Optional | The last name of the user associated with the account. |
phone | string | Optional | The phone number associated with the account. |
postalCode | string | Optional | The postal code associated with the address. Maximum length: 20 characters. |
state | string | Optional | The state or province associated with the address. Maximum length: 40 characters. |
supportedCountries | array | Optional | An array of supported countries associated with the account. |
supportedCountries[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a credit card that is associated with an account. |
address | Model | Optional | Expand Get credit card information — response body — address A complex element containing the credit card billing address information. |
cardLastDigits | string | Optional | |
cardNumber | string | Optional | The credit card number. |
cardType | string | Optional | The type of credit card. Valid values are: - `visa` - `mastercard` - `amex` |
cvNumber | string | Optional | 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 | Optional | The month that the credit card expires, expressed as a number from 1 to 12. |
expirationYear | string | Optional | The year in which the credit card expires, in 4-digit format. |
nameOnCard | string | Optional | The exact name as it appears on the credit card. |
tokenizedCard | string | Optional |
Referenced models: Get credit card information — response body — address
Get Account Billing Plan — response body — payment Processor Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Get credit card information — response body — address The mailing address associated with the payment processor. |
billingAgreementId | string | Optional | The ID of the billing agreement. |
email | string | Optional | The email address associated with the payment processor. |
Referenced models: Get credit card information — response body — address
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.