Retrieves the billing plan details for the specified billing plan ID.

Request

HTTP request

GET /v2.1/billing_plans/{billingPlanId}

Parameters

Parameter NameValueDescription
Path Parameters
billingPlanIdstring

The ID of the billing plan being accessed.

Responses

CodeDescriptionReference
200

Successful response.

billingPlanResponse
400

Error encountered.

errorDetails

SDK Method

Billing::getBillingPlan

Definitions

appStoreProduct

Contains information about an APP store product.

marketPlacestring

productIdstring

The Product ID from the AppStore.

billingPlan

Contains information about a billing plan.

appStoreProducts[appStoreProduct]

Reserved for DocuSign.

currencyPlanPrices[currencyPlanPrice]

Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.

enableSupportstring

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

includedSeatsstring

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

otherDiscountPercentstring

Any other percentage discount for the plan.

Example: "0.00"

paymentCyclestring

The payment cycle associated with the plan. The possible values are:

  • Monthly
  • Annually

paymentMethodstring

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

  • NotSupported
  • CreditCard
  • PurchaseOrder
  • Premium
  • Freemium
  • FreeTrial
  • AppStore
  • DigitalExternal
  • DirectDebit

perSeatPricestring

The per-seat price associated with the plan.

Example: "456.0000"

planClassificationstring

Identifies the type of plan. Examples include:

  • business
  • corporate
  • enterprise
  • free

planFeatureSets[featureSet]

Reserved for DocuSign.

planIdstring

DocuSign's id for the account plan.

planNamestring

seatDiscounts[seatDiscount]

A complex type that returns information about any seat discounts. It contains the information BeginSeatCount, EndSeatCount and SeatDiscountPercent.

supportIncidentFeestring

The support incident fee charged for each support incident.

Example: "$0.00"

supportPlanFeestring

The support plan fee charged for this plan.

Example: "$0.00"

billingPlanResponse

Defines a billing plan response object.

billingPlanbillingPlan

An object that contains details about the billing plan.

successorPlans[billingPlan]

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

creditCardTypes

cardTypes[array]

An array containing supported credit card types.

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.

currencyPlanPrice

currencyCodestring

Specifies the ISO currency code for the account.

currencySymbolstring

Specifies the currency symbol for the account.

perSeatPricestring

The per-seat price associated with the plan.

Example: "456.0000"

supportedCardTypescreditCardTypes

A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).

supportIncidentFeestring

The support incident fee charged for each support incident.

Example: "$0.00"

supportPlanFeestring

The support plan fee charged for this plan.

Example: "$0.00"

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.

seatDiscount

This object contains information about a seat discount.

beginSeatCountstring

Reserved for DocuSign.

discountPercentstring

The percent of the discount.

Example: "0.00"

endSeatCountstring

Reserved for DocuSign.

Examples

Generic JSON Response

Response
{
  "billingPlan": {
    "planName": "sample string 1",
    "paymentCycle": "sample string 2",
    "paymentMethod": "sample string 3",
    "planClassification": "sample string 4",
    "perSeatPrice": "sample string 5",
    "otherDiscountPercent": "sample string 6",
    "supportIncidentFee": "sample string 7",
    "supportPlanFee": "sample string 8",
    "includedSeats": "sample string 9",
    "enableSupport": "sample string 10",
    "planId": "sample string 11",
    "seatDiscounts": [
      {
        "beginSeatCount": "sample string 1",
        "endSeatCount": "sample string 2",
        "discountPercent": "sample string 3"
      }
    ],
    "planFeatureSets": [
      {
        "featureSetId": "sample string 1",
        "isActive": "sample string 2",
        "name": "sample string 3",
        "fixedFee": "sample string 4",
        "envelopeFee": "sample string 5",
        "seatFee": "sample string 6",
        "isEnabled": "sample string 7",
        "is21CFRPart11": "sample string 8",
        "currencyFeatureSetPrices": [
          {
            "currencyCode": "sample string 1",
            "fixedFee": "sample string 2",
            "seatFee": "sample string 3",
            "envelopeFee": "sample string 4",
            "currencySymbol": "sample string 5"
          }
        ]
      }
    ],
    "currencyPlanPrices": [
      {
        "currencyCode": "sample string 1",
        "perSeatPrice": "sample string 2",
        "supportIncidentFee": "sample string 3",
        "supportPlanFee": "sample string 4",
        "currencySymbol": "sample string 5",
        "supportedCardTypes": {
          "cardTypes": [
            "sample string 1"
          ]
        }
      }
    ],
    "appStoreProducts": [
      {
        "productId": "sample string 1",
        "marketPlace": "sample string 2"
      }
    ]
  },
  "successorPlans": [
    {}
  ]
}
Generic XML Response

Response
<billingPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <billingPlan>
    <appStoreProducts>
      <appStoreProduct>
        <marketPlace>sample string 2</marketPlace>
        <productId>sample string 1</productId>
      </appStoreProduct>
    </appStoreProducts>
    <currencyPlanPrices>
      <currencyPlanPrice>
        <currencyCode>sample string 1</currencyCode>
        <currencySymbol>sample string 5</currencySymbol>
        <perSeatPrice>sample string 2</perSeatPrice>
        <supportIncidentFee>sample string 3</supportIncidentFee>
        <supportPlanFee>sample string 4</supportPlanFee>
        <supportedCardTypes>
          <cardTypes>
            <string>sample string 1</string>
          </cardTypes>
        </supportedCardTypes>
      </currencyPlanPrice>
    </currencyPlanPrices>
    <enableSupport>sample string 10</enableSupport>
    <includedSeats>sample string 9</includedSeats>
    <otherDiscountPercent>sample string 6</otherDiscountPercent>
    <paymentCycle>sample string 2</paymentCycle>
    <paymentMethod>sample string 3</paymentMethod>
    <perSeatPrice>sample string 5</perSeatPrice>
    <planClassification>sample string 4</planClassification>
    <planFeatureSets>
      <featureSet>
        <currencyFeatureSetPrices>
          <currencyFeatureSetPrice>
            <currencyCode>sample string 1</currencyCode>
            <currencySymbol>sample string 5</currencySymbol>
            <envelopeFee>sample string 4</envelopeFee>
            <fixedFee>sample string 2</fixedFee>
            <seatFee>sample string 3</seatFee>
          </currencyFeatureSetPrice>
        </currencyFeatureSetPrices>
        <envelopeFee>sample string 5</envelopeFee>
        <featureSetId>sample string 1</featureSetId>
        <fixedFee>sample string 4</fixedFee>
        <is21CFRPart11>sample string 8</is21CFRPart11>
        <isActive>sample string 2</isActive>
        <isEnabled>sample string 7</isEnabled>
        <name>sample string 3</name>
        <seatFee>sample string 6</seatFee>
      </featureSet>
    </planFeatureSets>
    <planId>sample string 11</planId>
    <planName>sample string 1</planName>
    <seatDiscounts>
      <seatDiscount>
        <beginSeatCount>sample string 1</beginSeatCount>
        <discountPercent>sample string 3</discountPercent>
        <endSeatCount>sample string 2</endSeatCount>
      </seatDiscount>
    </seatDiscounts>
    <supportIncidentFee>sample string 7</supportIncidentFee>
    <supportPlanFee>sample string 8</supportPlanFee>
  </billingPlan>
  <successorPlans>
    <billingPlan />
  </successorPlans>
</billingPlanResponse> 
}} />