docusign.billing-plans.put-purchased-envelopes

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.

Reserved: Purchase additional envelopes.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
amount	string	No	—	The total amount of the purchase.
appname	string	No	—	The AppName of the client application.
currencycode	string	No	—	Specifies the ISO 4217 currency code of the purchase.
platform	string	No	—	The Platform of the client application
productid	string	No	—	The Product ID from the AppStore.
quantity	string	No	—	The quantity of envelopes to add to the account.
receiptdata	string	No	—	The encrypted Base64 encoded receipt data.
storename	string	No	—	The name of the AppStore.
transactionid	string	No	—	Specifies the Transaction ID from the AppStore.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
amount	string	No	—	The total amount of the purchase.
appname	string	No	—	The AppName of the client application.
currencycode	string	No	—	Specifies the ISO 4217 currency code of the purchase.
platform	string	No	—	The Platform of the client application
productid	string	No	—	The Product ID from the AppStore.
quantity	string	No	—	The quantity of envelopes to add to the account.
receiptdata	string	No	—	The encrypted Base64 encoded receipt data.
storename	string	No	—	The name of the AppStore.
transactionid	string	No	—	Specifies the Transaction ID from the AppStore.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.billing-plans.put-purchased-envelopes",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}