Update account billing plan

PUT

/v2.1/accounts/:accountId/billing_plan

PUT

/restapi/v2.1/accounts/:accountId/billing_plan

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/billing_plan \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "appStoreReceipt": {
    "downgradeProductId": "sample string 1",
    "isDowngradeCancellation": "sample string 2",
    "productId": "sample string 3",
    "receiptData": "sample string 4"
  },
  "billingAddress": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "country": "sample string 4",
    "email": "sample string 5",
    "fax": "sample string 6",
    "firstName": "sample string 7",
    "lastName": "sample string 8",
    "phone": "sample string 9",
    "postalCode": "sample string 10",
    "state": "sample string 11",
    "supportedCountries": [
      {
        "isoCode": "sample string 1",
        "name": "sample string 2",
        "provinces": [
          {
            "isoCode": "sample string 1",
            "name": "sample string 2"
          }
        ],
        "provinceValidated": "sample string 3"
      }
    ]
  },
  "creditCardInformation": {
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "country": "sample string 4",
      "fax": "sample string 5",
      "phone": "sample string 6",
      "postalCode": "sample string 7",
      "stateOrProvince": "sample string 8",
      "zipPlus4": "sample string 9"
    },
    "cardLastDigits": "sample string 1",
    "cardNumber": "sample string 2",
    "cardType": "sample string 3",
    "cvNumber": "sample string 4",
    "expirationMonth": "sample string 5",
    "expirationYear": "sample string 6",
    "nameOnCard": "sample string 7",
    "tokenizedCard": "sample string 8"
  },
  "directDebitProcessorInformation": {
    "bankBranchCode": "sample string 1",
    "bankCheckDigit": "sample string 2",
    "bankCode": "sample string 3",
    "bankName": "sample string 4",
    "bankTransferAccountName": "sample string 5",
    "bankTransferAccountNumber": "sample string 6",
    "bankTransferType": "sample string 7",
    "country": "sample string 8",
    "email": "sample string 9",
    "firstName": "sample string 10",
    "iBAN": "sample string 11",
    "lastName": "sample string 12"
  },
  "downgradeReason": "sample string 1",
  "enablePreAuth": "sample string 2",
  "enableSupport": "sample string 3",
  "includedSeats": "sample string 4",
  "incrementalSeats": "sample string 5",
  "paymentMethod": "sample string 6",
  "paymentProcessor": "sample string 7",
  "paymentProcessorInformation": {
    "billingAgreementId": "sample string 1",
    "email": "sample string 2"
  },
  "planInformation": {
    "addOns": [
      {
        "active": "sample string 1",
        "addOnId": "sample string 2",
        "id": "sample string 3",
        "name": "sample string 4"
      }
    ],
    "currencyCode": "sample string 1",
    "freeTrialDaysOverride": "sample string 2",
    "planFeatureSets": [
      {
        "currencyFeatureSetPrices": [
          {
            "currencyCode": "sample string 1",
            "currencySymbol": "sample string 2",
            "envelopeFee": "sample string 3",
            "fixedFee": "sample string 4",
            "seatFee": "sample string 5"
          }
        ],
        "envelopeFee": "sample string 1",
        "featureSetId": "sample string 2",
        "fixedFee": "sample string 3",
        "is21CFRPart11": "sample string 4",
        "isActive": "sample string 5",
        "isEnabled": "sample string 6",
        "name": "sample string 7",
        "seatFee": "sample string 8"
      }
    ],
    "planId": "sample string 3",
    "recipientDomains": [
      {
        "active": "sample string 1",
        "domainCode": "sample string 2",
        "domainName": "sample string 3",
        "recipientDomainId": "sample string 4"
      }
    ]
  },
  "processPayment": "sample string 8",
  "referralInformation": {
    "advertisementId": "sample string 1",
    "enableSupport": "sample string 2",
    "externalOrgId": "sample string 3",
    "groupMemberId": "sample string 4",
    "idType": "sample string 5",
    "includedSeats": "sample string 6",
    "industry": "sample string 7",
    "planStartMonth": "sample string 8",
    "promoCode": "sample string 9",
    "publisherId": "sample string 10",
    "referralCode": "sample string 11",
    "referrerName": "sample string 12",
    "saleDiscountAmount": "sample string 13",
    "saleDiscountFixedAmount": "sample string 14",
    "saleDiscountPercent": "sample string 15",
    "saleDiscountPeriods": "sample string 16",
    "saleDiscountSeatPriceOverride": "sample string 17",
    "shopperId": "sample string 18"
  },
  "renewalStatus": "sample string 9",
  "saleDiscountAmount": "sample string 10",
  "saleDiscountFixedAmount": "sample string 11",
  "saleDiscountPercent": "sample string 12",
  "saleDiscountPeriods": "sample string 13",
  "saleDiscountSeatPriceOverride": "sample string 14",
  "taxExemptId": "sample string 15"
}'

{
  "accountPaymentMethod": "sample string 1",
  "billingPlanPreview": {
    "currencyCode": "sample string 1",
    "invoice": {
      "amount": "sample string 1",
      "balance": "sample string 2",
      "dueDate": "sample string 3",
      "invoiceId": "sample string 4",
      "invoiceItems": [
        {
          "chargeAmount": "sample string 1",
          "chargeName": "sample string 2",
          "invoiceItemId": "sample string 3",
          "quantity": "sample string 4",
          "taxAmount": "sample string 5",
          "taxExemptAmount": "sample string 6",
          "unitPrice": "sample string 7"
        }
      ],
      "invoiceNumber": "sample string 5",
      "invoiceUri": "sample string 6",
      "nonTaxableAmount": "sample string 7",
      "pdfAvailable": "sample string 8",
      "taxableAmount": "sample string 9"
    },
    "isProrated": "sample string 2",
    "subtotalAmount": "sample string 3",
    "taxAmount": "sample string 4",
    "totalAmount": "sample string 5"
  },
  "currencyCode": "sample string 2",
  "includedSeats": "sample string 3",
  "paymentCycle": "sample string 4",
  "paymentMethod": "sample string 5",
  "planId": "sample string 6",
  "planName": "sample string 7"
}

Updates the billing plan information, billing address, and credit card information for the specified 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.

Query parameters

preview_billing_planstringOptional

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

Request

This endpoint expects an object: billingPlanInformation

appStoreReceiptobjectOptional

Contains information about an APP store receipt.

billingAddressobjectOptional

Contains information about the address associated with the account.

creditCardInformationobjectOptional

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

directDebitProcessorInformationobjectOptional

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

downgradeReasonstringOptional

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

enablePreAuthstringOptional

enableSupportstringOptional

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

includedSeatsstringOptional

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

incrementalSeatsstringOptional

Reserved for Docusign.

paymentMethodstringOptional

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

NotSupported
CreditCard
PurchaseOrder
Premium
Freemium
FreeTrial
AppStore
DigitalExternal
DirectDebit

paymentProcessorstringOptional

paymentProcessorInformationobjectOptional

planInformationobjectOptional

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

processPaymentstringOptional

referralInformationobjectOptional

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.

renewalStatusstringOptional

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`.

saleDiscountAmountstringOptional

Reserved for Docusign.

saleDiscountFixedAmountstringOptional

Reserved for Docusign.

saleDiscountPercentstringOptional

Reserved for Docusign.

saleDiscountPeriodsstringOptional

Reserved for Docusign.

saleDiscountSeatPriceOverridestringOptional

Reserved for Docusign.

taxExemptIdstringOptional

Response

Successful response.

accountPaymentMethodstringOptional

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

credit_card

billingPlanPreviewobjectOptional

Information used to provide a preview of a billing plan.

currencyCodestringOptional

Specifies the ISO 4217 currency code for the account.

includedSeatsstringOptional

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

paymentCyclestringOptional

The payment cycle associated with the plan. Valid values:

Monthly
Annually

paymentMethodstringOptional

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

NotSupported
CreditCard
PurchaseOrder
Premium
Freemium
FreeTrial
AppStore
DigitalExternal
DirectDebit

planIdstringOptional

Docusign's ID for the account plan.

planNamestringOptional

The name of the billing plan used for the account.

Examples:

Personal - Annual
Unlimited Envelope Subscription - Annual Billing

Errors

400

Bad Request Error