Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Billing Plans

Updates an account billing plan

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

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

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Query Parameters

preview_billing_plan?string

When true, updates the account using a preview billing plan.

Request Body

application/json

This object contains details about a billing plan.

appStoreReceipt?

Contains information about an APP store receipt.

billingAddress?

Contains information about the address associated with the account.

creditCardInformation?

This object contains information about a credit card that is associated with an account.

directDebitProcessorInformation?

Contains information about a bank that processes a customer's direct debit payments.

downgradeReason?string

(Optional) The user's reason for downgrading their billing plan.

enablePreAuth?string
enableSupport?string

When true, customer support is provided as part of the account plan.

includedSeats?string

The number of seats (users) included in the plan.

incrementalSeats?string

Reserved for Docusign.

paymentMethod?string

The payment method used for the billing plan. Valid values are:

  • NotSupported
  • CreditCard
  • PurchaseOrder
  • Premium
  • Freemium
  • FreeTrial
  • AppStore
  • DigitalExternal
  • DirectDebit
paymentProcessor?string
paymentProcessorInformation?
planInformation?

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

processPayment?string
referralInformation?

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

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

Reserved for Docusign.

saleDiscountFixedAmount?string

Reserved for Docusign.

saleDiscountPercent?string

Reserved for Docusign.

saleDiscountPeriods?string

Reserved for Docusign.

saleDiscountSeatPriceOverride?string

Reserved for Docusign.

taxExemptId?string

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/billing_plan" \  -H "Content-Type: application/json" \  -d '{}'
{  "accountPaymentMethod": "string",  "billingPlanPreview": {    "currencyCode": "string",    "invoice": {      "amount": "string",      "balance": "string",      "dueDate": "string",      "invoiceId": "string",      "invoiceItems": [        {          "chargeAmount": "string",          "chargeName": "string",          "invoiceItemId": "string",          "quantity": "string",          "taxAmount": "string",          "taxExemptAmount": "string",          "unitPrice": "string"        }      ],      "invoiceNumber": "string",      "invoiceUri": "string",      "nonTaxableAmount": "string",      "pdfAvailable": "string",      "taxableAmount": "string"    },    "isProrated": "string",    "subtotalAmount": "string",    "taxAmount": "string",    "totalAmount": "string"  },  "currencyCode": "string",  "includedSeats": "string",  "paymentCycle": "string",  "paymentMethod": "string",  "planId": "string",  "planName": "string"}

Get Account Billing Plan GET

Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false.** Response The response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [Billing: getBillingPlan](https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/get/) reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [Billing: updatePlan](https://developers.docusign.com/docs/esign-rest-api/reference/billing/billingplans/update/) reference. **Note:** When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.

Get credit card information GET

This method returns information about a credit card associated with an account.