BillingPlans: purchaseEnvelopes

Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.

Request

HTTP request

PUT /v2/accounts/{accountId}/billing_plan/purchased_envelopes

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Billing::purchaseEnvelopes

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

purchasedEnvelopesInformation

amountstring

The total amount of the purchase.

appNamestring

The AppName of the client application.

currencyCodestring

Specifies the ISO currency code of the purchase. This is based on the ISO 4217 currency code information.

platformstring

The Platform of the client application

productIdstring

The Product ID from the AppStore.

quantitystring

The quantity of envelopes to add to the account.

receiptDatastring

The encrypted Base64 encoded receipt data.

storeNamestring

The name of the AppStore.

transactionIdstring

Specifies the Transaction ID from the AppStore.

Examples

Generic JSON Request

Request
{
  "quantity": "sample string 1",
  "transactionId": "sample string 2",
  "platform": "sample string 3",
  "appName": "sample string 4",
  "storeName": "sample string 5",
  "receiptData": "sample string 6",
  "amount": "sample string 7",
  "currencyCode": "sample string 8",
  "productId": "sample string 9"
}
Generic XML Request

Request
<purchasedEnvelopesInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <amount>sample string 7</amount>
  <appName>sample string 4</appName>
  <currencyCode>sample string 8</currencyCode>
  <platform>sample string 3</platform>
  <productId>sample string 9</productId>
  <quantity>sample string 1</quantity>
  <receiptData>sample string 6</receiptData>
  <storeName>sample string 5</storeName>
  <transactionId>sample string 2</transactionId>
</purchasedEnvelopesInformation> 
}} />