docusign.billing-plans.put-billing-plan

Updates the billing plan information, billing address, and credit card information for the specified account.

Updates an account billing plan.

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.
preview_billing_plan	string	No	—	When true, updates the account using a preview billing plan.
appstorereceipt	json	No	—	Contains information about an APP store receipt.
billingaddress	json	No	—	Contains information about the address associated with the account.
creditcardinformation	json	No	—	This object contains information about a credit card that is associated with an account.
directdebitprocessorinformation	json	No	—	Contains information about a bank that processes a customer's direct debit payments.
downgradereason	string	No	—	(Optional) The user's reason for downgrading their billing plan.
enablepreauth	string	No	—	—
enablesupport	string	No	—	When true, customer support is provided as part of the account plan.
includedseats	string	No	—	The number of seats (users) included in the plan.
incrementalseats	string	No	—	Reserved for Docusign.
paymentmethod	string	No	—	The payment method used for the billing plan. Valid values are: - NotSupported - CreditCard - PurchaseOrder - Premium - Freemium - FreeTrial - AppStore - DigitalExternal - DirectDebit
paymentprocessor	string	No	—	—
paymentprocessorinformation	json	No	—	—
planinformation	json	No	—	An object used to identify the features and attributes of the account being created.
processpayment	string	No	—	—
referralinformation	json	No	—	A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only.
renewalstatus	string	No	—	The renewal status of the account. Possible values are: - auto: The account automatically renews. - queued_for_close: The account will be closed at the billingPeriodEndDate. - queued_for_downgrade: The account will be downgraded at the billingPeriodEndDate`.
salediscountamount	string	No	—	Reserved for Docusign.
salediscountfixedamount	string	No	—	Reserved for Docusign.
salediscountpercent	string	No	—	Reserved for Docusign.
salediscountperiods	string	No	—	Reserved for Docusign.
salediscountseatpriceoverride	string	No	—	Reserved for Docusign.
taxexemptid	string	No	—	—

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.
preview_billing_plan	string	No	—	When true, updates the account using a preview billing plan.
appstorereceipt	json	No	—	Contains information about an APP store receipt.
billingaddress	json	No	—	Contains information about the address associated with the account.
creditcardinformation	json	No	—	This object contains information about a credit card that is associated with an account.
directdebitprocessorinformation	json	No	—	Contains information about a bank that processes a customer's direct debit payments.
downgradereason	string	No	—	(Optional) The user's reason for downgrading their billing plan.
enablepreauth	string	No	—	—
enablesupport	string	No	—	When true, customer support is provided as part of the account plan.
includedseats	string	No	—	The number of seats (users) included in the plan.
incrementalseats	string	No	—	Reserved for Docusign.
paymentmethod	string	No	—	The payment method used for the billing plan. Valid values are: - NotSupported - CreditCard - PurchaseOrder - Premium - Freemium - FreeTrial - AppStore - DigitalExternal - DirectDebit
paymentprocessor	string	No	—	—
paymentprocessorinformation	json	No	—	—
planinformation	json	No	—	An object used to identify the features and attributes of the account being created.
processpayment	string	No	—	—
referralinformation	json	No	—	A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only.
renewalstatus	string	No	—	The renewal status of the account. Possible values are: - auto: The account automatically renews. - queued_for_close: The account will be closed at the billingPeriodEndDate. - queued_for_downgrade: The account will be downgraded at the billingPeriodEndDate`.
salediscountamount	string	No	—	Reserved for Docusign.
salediscountfixedamount	string	No	—	Reserved for Docusign.
salediscountpercent	string	No	—	Reserved for Docusign.
salediscountperiods	string	No	—	Reserved for Docusign.
salediscountseatpriceoverride	string	No	—	Reserved for Docusign.
taxexemptid	string	No	—	—
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
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
* (any state)	fail	failed	Record the failure reason

API Usage

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

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