Skip to content

DocuSign: Queues downgrade billing plan request for an account

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

← Esignature operations · Get started

Operation docusign.esignature_billingplan_putdowngradeaccountbillingplan

Provider route: PUT /restapi/v2.1/accounts/{accountId}/billing_plan/downgrade. 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"]["esignatureBillingPlanPutDowngradeAccountBillingPlan"]>[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.esignatureBillingPlanPutDowngradeAccountBillingPlan(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_downgrade_account_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
bodyModelOptionalExpand Queues downgrade billing plan request for an account — request body — body

Referenced models: Queues downgrade billing plan request for an account — 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 Queues downgrade billing plan request for an account — response body

Referenced models: Queues downgrade billing plan request for an account — response body

Queues downgrade billing plan request for an account — response body
FieldTypePresenceDescription and constraints
$objectRoot
accountPaymentMethodstringOptionalThe type of payment method used for the account. Valid values are:

- `credit_card`
-
discountAppliedstringOptional
downgradeEffectiveDatestringOptional
downgradePaymentCyclestringOptional
downgradePlanIdstringOptional
downgradePlanNamestringOptional
downgradeRequestStatusstringOptional
messagestringOptional
productIdstringOptionalThe Product ID from the AppStore.
promoCodestringOptional
saleDiscountstringOptional
saleDiscountPeriodsstringOptionalReserved for Docusign.
saleDiscountTypestringOptional
Queues downgrade billing plan request for an account — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
downgradeEventTypestringOptional
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.
promoCodestringOptional
saleDiscountstringOptional
saleDiscountPeriodsstringOptionalReserved for Docusign.
saleDiscountTypestringOptional

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

Updates an account billing plan — request body — body plan Information
FieldTypePresenceDescription and constraints
$objectRootAn object used to identify the features and attributes of the account being created.
addOnsarrayOptionalReserved for Docusign.
addOns[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan add Ons item
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account.
freeTrialDaysOverridestringOptionalReserved for Docusign.
planFeatureSetsarrayOptionalReserved for Docusign.
planFeatureSets[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan plan Feature Sets item
planIdstringOptionalDocusign's ID for the account plan.
recipientDomainsarrayOptional
recipientDomains[]ModelEach itemExpand Retrieves the account information for the specified account — response body — recipient Domains item

Referenced models: Get Account Billing Plan — response body — billing Plan add Ons item, Get Account Billing Plan — response body — billing Plan plan Feature Sets item, Retrieves the account information for the specified account — response body — recipient Domains item

Get Account Billing Plan — response body — billing Plan add Ons item
FieldTypePresenceDescription and constraints
$objectRootContains information about add ons.
activestringOptionalReserved for Docusign.
addOnIdstringOptionalReserved for Docusign.
idstringOptionalA unique ID for the Salesforce object.
namestringOptionalReserved for Docusign.
Get Account Billing Plan — response body — billing Plan plan Feature Sets item
FieldTypePresenceDescription and constraints
$objectRootThis object provides details about a feature set, or add-on product that is associated with an account. It is reserved for Docusign internal use only.
currencyFeatureSetPricesarrayOptionalReserved for Docusign.
currencyFeatureSetPrices[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
envelopeFeestringOptionalReserved for Docusign.
featureSetIdstringOptionalReserved for Docusign.
fixedFeestringOptionalReserved for Docusign.
is21CFRPart11stringOptionalReserved for Docusign.
isActivestringOptionalReserved for Docusign.
isEnabledstringOptionalWhen **true,** the feature set is actively enabled as part of the plan.
namestringOptionalReserved for Docusign.
seatFeestringOptionalReserved for Docusign.

Referenced models: Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item

Retrieves the account information for the specified account — response body — recipient Domains item
FieldTypePresenceDescription and constraints
$objectRoot
activestringOptional
domainCodestringOptional
domainNamestringOptional
recipientDomainIdstringOptional
Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
FieldTypePresenceDescription and constraints
$objectRootInformation about the price and currency associated with the feature set. Reserved for internal Docusign use only.
currencyCodestringOptionalSpecifies the alternate ISO currency code for the account.
currencySymbolstringOptionalReserved for Docusign.
envelopeFeestringOptionalReserved for Docusign.
fixedFeestringOptionalReserved for Docusign.
seatFeestringOptionalReserved for Docusign.

SDK function policy ID: docusign.esignature_billingplan_putdowngradeaccountbillingplan. Catalog operation: esignature:BillingPlan_PutDowngradeAccountBillingPlan. 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.