Skip to content

DocuSign: Reserved: Purchase additional envelopes

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

← Esignature operations · Get started

Operation docusign.esignature_purchasedenvelopes_putpurchasedenvelopes

Provider route: PUT /restapi/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes. 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"]["esignaturePurchasedEnvelopesPutPurchasedEnvelopes"]>[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.esignaturePurchasedEnvelopesPutPurchasedEnvelopes(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_purchased_envelopes_put_purchased_envelopes(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 Reserved: Purchase additional envelopes — request body — body

Referenced models: Reserved: Purchase additional envelopes — 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
$JSONRoot
Reserved: Purchase additional envelopes — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
amountstringOptionalThe total amount of the purchase.
appNamestringOptionalThe AppName of the client application.
currencyCodestringOptionalSpecifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase.
platformstringOptionalThe Platform of the client application
productIdstringOptionalThe Product ID from the AppStore.
quantitystringOptionalThe quantity of envelopes to add to the account.
receiptDatastringOptionalThe encrypted Base64 encoded receipt data.
storeNamestringOptionalThe name of the AppStore.
transactionIdstringOptionalSpecifies the Transaction ID from the AppStore.

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