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 name Value Description
Path parameters
accountId string

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

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Billing::purchaseEnvelopes

Definitions Expand All | Collapse All

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

purchasedEnvelopesInformation

amount string

The total amount of the purchase.

appName string

The AppName of the client application.

currencyCode string

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

platform string

The Platform of the client application

productId string

The Product ID from the AppStore.

quantity string

The quantity of envelopes to add to the account.

receiptData string

The encrypted Base64 encoded receipt data.

storeName string

The name of the AppStore.

transactionId string

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>