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.
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"]["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 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_downgrade_account_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 | |
body | Model | Optional | Expand 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
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 Queues downgrade billing plan request for an account — response body |
Referenced models: Queues downgrade billing plan request for an account — response body
Schemas
Section titled “Schemas”Queues downgrade billing plan request for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountPaymentMethod | string | Optional | The type of payment method used for the account. Valid values are: - `credit_card` - |
discountApplied | string | Optional | |
downgradeEffectiveDate | string | Optional | |
downgradePaymentCycle | string | Optional | |
downgradePlanId | string | Optional | |
downgradePlanName | string | Optional | |
downgradeRequestStatus | string | Optional | |
message | string | Optional | |
productId | string | Optional | The Product ID from the AppStore. |
promoCode | string | Optional | |
saleDiscount | string | Optional | |
saleDiscountPeriods | string | Optional | Reserved for Docusign. |
saleDiscountType | string | Optional |
Queues downgrade billing plan request for an account — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
downgradeEventType | string | Optional | |
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. |
promoCode | string | Optional | |
saleDiscount | string | Optional | |
saleDiscountPeriods | string | Optional | Reserved for Docusign. |
saleDiscountType | string | Optional |
Referenced models: Updates an account billing plan — request body — body plan Information
Updates an account billing plan — request body — body plan Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object used to identify the features and attributes of the account being created. |
addOns | array | Optional | Reserved for Docusign. |
addOns[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan add Ons item |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
freeTrialDaysOverride | string | Optional | Reserved for Docusign. |
planFeatureSets | array | Optional | Reserved for Docusign. |
planFeatureSets[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item |
planId | string | Optional | Docusign's ID for the account plan. |
recipientDomains | array | Optional | |
recipientDomains[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about add ons. |
active | string | Optional | Reserved for Docusign. |
addOnId | string | Optional | Reserved for Docusign. |
id | string | Optional | A unique ID for the Salesforce object. |
name | string | Optional | Reserved for Docusign. |
Get Account Billing Plan — response body — billing Plan plan Feature Sets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This 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. |
currencyFeatureSetPrices | array | Optional | Reserved for Docusign. |
currencyFeatureSetPrices[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item |
envelopeFee | string | Optional | Reserved for Docusign. |
featureSetId | string | Optional | Reserved for Docusign. |
fixedFee | string | Optional | Reserved for Docusign. |
is21CFRPart11 | string | Optional | Reserved for Docusign. |
isActive | string | Optional | Reserved for Docusign. |
isEnabled | string | Optional | When **true,** the feature set is actively enabled as part of the plan. |
name | string | Optional | Reserved for Docusign. |
seatFee | string | Optional | Reserved 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | string | Optional | |
domainCode | string | Optional | |
domainName | string | Optional | |
recipientDomainId | string | Optional |
Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the price and currency associated with the feature set. Reserved for internal Docusign use only. |
currencyCode | string | Optional | Specifies the alternate ISO currency code for the account. |
currencySymbol | string | Optional | Reserved for Docusign. |
envelopeFee | string | Optional | Reserved for Docusign. |
fixedFee | string | Optional | Reserved for Docusign. |
seatFee | string | Optional | Reserved for Docusign. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.