DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Billing Plan → Purchase Envelopes

AI-generated

Summary

Purchase envelope slots for a DocuSign account.

Inputs

  • authentication — Authentication method to use for DocuSign API access. Defaults to OAuth2 if not specified. Select 'JWT (Service Integration)' for service account credentials.
  • accountId (required) — The DocuSign Account ID (GUID). Required for account-scoped operations. Find it in DocuSign Admin → API and Keys.
  • requestBody (required) — JSON body specifying envelope purchase details. Must include amount (string) and quantity (string). Default: { amount: '0.00', quantity: '100' }. Example: { 'amount': '50.00', 'quantity': '10' }.
  • category — The API category to work with. Defaults to 'envelopes'. For billing plan operations, this resource implies the billing category.

Output shape

DocuSign API response envelope purchase confirmation, typically including receipt ID, purchased amount, quantity, and updated account envelope slot balance.

Returns the DocuSign API response for the envelope purchase. Exact return shape not explicitly documented in provided properties or source; describe based on typical DocuSign purchase-envelopes endpoint behavior.

Examples

Example 1: Purchase 100 envelope slots using OAuth2 authentication.

authentication: oAuth2; accountId: '12345678-1234-1234-1234-123456789012'; requestBody: { amount: '0.00', quantity: '100' }; category: 'billing'.

Links

Discussion