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.
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"]["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 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_purchased_envelopes_put_purchased_envelopes(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 Reserved: Purchase additional envelopes — request body — body |
Referenced models: Reserved: Purchase additional envelopes — 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 |
|---|---|---|---|
$ | JSON | Root |
Schemas
Section titled “Schemas”Reserved: Purchase additional envelopes — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | The total amount of the purchase. |
appName | string | Optional | The AppName of the client application. |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase. |
platform | string | Optional | The Platform of the client application |
productId | string | Optional | The Product ID from the AppStore. |
quantity | string | Optional | The quantity of envelopes to add to the account. |
receiptData | string | Optional | The encrypted Base64 encoded receipt data. |
storeName | string | Optional | The name of the AppStore. |
transactionId | string | Optional | Specifies the Transaction ID from the AppStore. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.