Get account billing plan

GET

/v2.1/accounts/:accountId/billing_plan

GET

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

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/billing_plan \
     -H "Authorization: Bearer <apiKey>"

{
  "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"
      }
    ]
  },
  "billingAddressIsCreditCardAddress": "sample string 1",
  "billingPlan": {
    "addOns": [
      {
        "active": "sample string 1",
        "addOnId": "sample string 2",
        "id": "sample string 3",
        "name": "sample string 4"
      }
    ],
    "appStoreReceiptExpirationDate": "sample string 1",
    "appStoreReceiptPurchaseDate": "sample string 2",
    "canCancelRenewal": "sample string 3",
    "canUpgrade": "sample string 4",
    "currencyCode": "sample string 5",
    "downgradePlanInformation": {
      "accountPaymentMethod": "sample string 1",
      "discountApplied": "sample string 2",
      "downgradeEffectiveDate": "sample string 3",
      "downgradePaymentCycle": "sample string 4",
      "downgradePlanId": "sample string 5",
      "downgradePlanName": "sample string 6",
      "downgradeRequestStatus": "sample string 7",
      "message": "sample string 8",
      "productId": "sample string 9",
      "promoCode": "sample string 10",
      "saleDiscount": "sample string 11",
      "saleDiscountPeriods": "sample string 12",
      "saleDiscountType": "sample string 13"
    },
    "enableSupport": "sample string 6",
    "includedSeats": "sample string 7",
    "incrementalSeats": "sample string 8",
    "isDowngrade": "sample string 9",
    "notificationType": "sample string 10",
    "otherDiscountPercent": "sample string 11",
    "paymentCycle": "sample string 12",
    "paymentMethod": "sample string 13",
    "perSeatPrice": "sample string 14",
    "planClassification": "sample string 15",
    "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 16",
    "planName": "sample string 17",
    "planStartDate": "sample string 18",
    "productId": "sample string 19",
    "renewalDate": "sample string 20",
    "renewalStatus": "sample string 21",
    "seatDiscounts": [
      {
        "beginSeatCount": "sample string 1",
        "discountPercent": "sample string 2",
        "endSeatCount": "sample string 3"
      }
    ],
    "subscriptionStartDate": "sample string 22",
    "supportIncidentFee": "sample string 23",
    "supportPlanFee": "sample string 24",
    "taxExemptId": "sample string 25"
  },
  "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"
  },
  "downgradeRequestInformation": {
    "downgradeRequestCreation": "sample string 1",
    "downgradeRequestProductId": "sample string 2",
    "downgradeRequestStatus": "sample string 3"
  },
  "entityInformation": {
    "billingProfile": "sample string 1",
    "entityName": "sample string 2",
    "externalEntityId": "sample string 3",
    "isExternallyBilled": "sample string 4"
  },
  "paymentMethod": "sample string 2",
  "paymentProcessorInformation": {
    "billingAgreementId": "sample string 1",
    "email": "sample string 2"
  },
  "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"
  },
  "successorPlans": [
    {
      "appStoreProducts": [
        {
          "marketPlace": "sample string 1",
          "productId": "sample string 2"
        }
      ],
      "currencyPlanPrices": [
        {
          "currencyCode": "sample string 1",
          "currencySymbol": "sample string 2",
          "perSeatPrice": "sample string 3",
          "supportedCardTypes": {
            "cardTypes": [
              "sample string 1"
            ]
          },
          "supportIncidentFee": "sample string 4",
          "supportPlanFee": "sample string 5"
        }
      ],
      "enableSupport": "sample string 1",
      "includedSeats": "sample string 2",
      "otherDiscountPercent": "sample string 3",
      "paymentCycle": "sample string 4",
      "paymentMethod": "sample string 5",
      "perSeatPrice": "sample string 6",
      "planClassification": "sample string 7",
      "planFeatureSets": [
        {}
      ],
      "planId": "sample string 8",
      "planName": "sample string 9",
      "seatDiscounts": [
        {}
      ],
      "supportIncidentFee": "sample string 10",
      "supportPlanFee": "sample string 11"
    }
  ],
  "taxExemptId": "sample string 3"
}

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 reference. the billingAddress and creditCardInformation property values are the same as those shown in the Billing: updatePlan 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.

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

include_credit_card_informationstringOptional

When true, payment information including credit card information will show in the return.

include_downgrade_informationstringOptional

include_metadatastringOptional

When true, the canUpgrade and renewalStatus properties are included the response and an array of supportedCountries is added to the billingAddress information.

include_successor_plansstringOptional

When true, excludes successor information from the response.

include_tax_exempt_idstringOptional

Response

Successful response.

billingAddressobjectOptional

Contains information about the address associated with the account.

billingAddressIsCreditCardAddressstringOptional

When true, the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different.

billingPlanobjectOptional

Contains information about an account billing plan.

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.

downgradePlanInformationobjectOptional

downgradeRequestInformationobjectOptional

entityInformationobjectOptional

paymentMethodstringOptional

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

NotSupported
CreditCard
PurchaseOrder
Premium
Freemium
FreeTrial
AppStore
DigitalExternal
DirectDebit

paymentProcessorInformationobjectOptional

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.

successorPlanslist of objectsOptional

A list of billing plans that the current billing plan can be rolled into.

taxExemptIdstringOptional

Errors

400

Bad Request Error