Skip to navigation

Queue downgrade billing plan request

View as Markdown
Queues downgrade billing plan request for an account.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

Request

This endpoint expects an object: downgradeBillingPlanInformation

downgradeEventTypestringOptional
planInformationobjectOptional
An object used to identify the features and attributes of the account being created.
promoCodestringOptional
saleDiscountstringOptional
saleDiscountPeriodsstringOptional
Reserved for Docusign.
saleDiscountTypestringOptional

Response

Successful response.
accountPaymentMethodstringOptional

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

  • credit_card
discountAppliedstringOptional
downgradeEffectiveDatestringOptional
downgradePaymentCyclestringOptional
downgradePlanIdstringOptional
downgradePlanNamestringOptional
downgradeRequestStatusstringOptional
messagestringOptional
productIdstringOptional
The Product ID from the AppStore.
promoCodestringOptional
saleDiscountstringOptional
saleDiscountPeriodsstringOptional
Reserved for Docusign.
saleDiscountTypestringOptional

Errors

400
Bad Request Error