Retrieves a list of the billing plans associated with a distributor.

Request

HTTP request

GET /v2/billing_plans

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Billing::listBillingPlans

Definitions Expand All | Collapse All

appStoreProduct

Contains information about an APP store product.

marketPlace string
productId string

The Product ID from the AppStore.

billingPlan

Contains information about a billing plan.

appStoreProducts
[appStoreProduct]

Reserved: TBD

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.

enableSupport string

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

includedSeats string

The number of seats (users) included.

otherDiscountPercent string
paymentCycle string

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

paymentMethod string
perSeatPrice string

The per seat price for the plan.

planClassification string

Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.

planFeatureSets
[featureSet]

A complex type that sets the feature sets for the account.

planId string

The DocuSign Plan ID for the account.

planName string

The name of the Billing Plan.

seatDiscounts
[seatDiscount]
supportIncidentFee string

The support incident fee charged for each support incident.

supportPlanFee string

The support plan fee charged for this plan.

billingPlansResponse

Defines a billing plans response object.

billingPlans
[billingPlan]

Reserved: TBD

creditCardTypes

cardTypes
[string]

An array containing supported credit card types.

currencyFeatureSetPrice

currencyCode string

Specifies the alternate ISO currency code for the account.

currencySymbol string

Specifies the alternate currency symbol for the account.

envelopeFee string

An incremental envelope cost for plans with envelope overages (when isEnabled is set to true.)

fixedFee string

Specifies a one-time fee associated with the plan (when isEnabled is set to true.)

seatFee string

Specifies an incremental seat cost for seat-based plans (when isEnabled is set to true.)

currencyPlanPrice

currencyCode string

Specifies the ISO currency code for the account.

currencySymbol string

Specifies the currency symbol for the account.

perSeatPrice string
supportedCardTypes creditCardTypes

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

supportIncidentFee string

The support incident fee charged for each support incident.

supportPlanFee string

The support plan fee charged for this plan.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

featureSet

currencyFeatureSetPrices
[currencyFeatureSetPrice]

A complex type that contains alternate currency values that are configured for this plan feature set.

envelopeFee string
featureSetId string

A unique ID for the feature set.

fixedFee string
is21CFRPart11 string

When set to true, indicates that this module is enabled on the account.

isActive string
isEnabled string

Specifies whether the feature set is actively enabled as part of the plan.

name string
seatFee string

An incremental seat cost for seat-based plans. Only valid when isEnabled for the feature set is set to true.

seatDiscount

beginSeatCount string

Reserved: TBD

discountPercent string
endSeatCount string

Reserved: TBD

Examples

Generic JSON Response

Response

{
"billingPlans": [
{
"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"
}
]
}
]
}

Generic XML Response

Response

<billingPlansResponse 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<billingPlans>
<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>
</billingPlans>
</billingPlansResponse>