BillingPlans: updateDowngradeAccountBillingPlan

Request

HTTP request

PUT /restapi/v2.1/accounts/{accountId}/billing_plan/downgrade

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

downgradePlanUpdateResponse
400

Error encountered.

errorDetails

SDK Method

Billing::updateDowngradeAccountBillingPlan

Definitions

addOn

Contains information about add ons.

activestring

Reserved for DocuSign.

addOnIdstring

Reserved for DocuSign.

idstring

A unique ID for the Salesforce object.

namestring

Reserved for DocuSign.

currencyFeatureSetPrice

Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.

currencyCodestring

Reserved for DocuSign.

currencySymbolstring

Reserved for DocuSign.

envelopeFeestring

Reserved for DocuSign.

fixedFeestring

Reserved for DocuSign.

seatFeestring

Reserved for DocuSign.

downgradeBillingPlanInformation

downgradeEventTypestring

planInformationplanInformation

An object used to identify the features and attributes of the account being created.

downgradePlanUpdateResponse

accountPaymentMethodstring

The type of payment method used for the account. Valid values are:

  • credit_card

downgradeEffectiveDatestring

downgradePaymentCyclestring

downgradePlanIdstring

downgradePlanNamestring

downgradeRequestStatusstring

messagestring

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

featureSet

This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.

currencyFeatureSetPrices[currencyFeatureSetPrice]

Reserved for DocuSign.

envelopeFeestring

Reserved for DocuSign.

featureSetIdstring

Reserved for DocuSign.

fixedFeestring

Reserved for DocuSign.

is21CFRPart11string

Reserved for DocuSign.

isActivestring

Reserved for DocuSign.

isEnabledstring

When set to true, the feature set is actively enabled as part of the plan.

namestring

Reserved for DocuSign.

seatFeestring

Reserved for DocuSign.

planInformation

An object used to identify the features and attributes of the account being created.

addOns[addOn]

Reserved for DocuSign.

currencyCodestring

Specifies the ISO currency code for the account.

freeTrialDaysOverridestring

Reserved for DocuSign.

planFeatureSets[featureSet]

Reserved for DocuSign.

planIdstring

DocuSign's id for the account plan.

recipientDomains[recipientDomain]

recipientDomain

activestring

domainCodestring

domainNamestring

recipientDomainIdstring

}} />