DocuSign: Gets a list of available billing plans
DocuSign esignature.esignatureBillingPlansGetBillingPlans: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_billingplans_getbillingplans
Provider route: GET /restapi/v2.1/billing_plans. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureBillingPlansGetBillingPlans"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureBillingPlansGetBillingPlans(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_billing_plans_get_billing_plans(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets a list of available billing plans — response body |
Referenced models: Gets a list of available billing plans — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Gets a list of available billing plans — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a billing plans response object. |
billingPlans | array | Optional | Reserved for Docusign. |
billingPlans[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan |
Referenced models: Gets billing plan details — response body — billing Plan
Gets billing plan details — response body — billing Plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about a billing plan. |
appStoreProducts | array | Optional | Reserved for Docusign. |
appStoreProducts[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan app Store Products item |
currencyPlanPrices | array | Optional | Contains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set. |
currencyPlanPrices[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan currency Plan Prices item |
enableSupport | string | Optional | When **true,** customer support is provided as part of the account plan. |
includedSeats | string | Optional | The number of seats (users) included in the plan. |
otherDiscountPercent | string | Optional | Any other percentage discount for the plan. Example: `"0.00"` |
paymentCycle | string | Optional | The payment cycle associated with the plan. Valid values: Monthly or Annually. |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
perSeatPrice | string | Optional | The per seat price for the plan. |
planClassification | string | Optional | Identifies the type of plan. Examples include: - `business` - `corporate` - `enterprise` - `free` |
planFeatureSets | array | Optional | Reserved for Docusign. |
planFeatureSets[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item |
planId | string | Optional | Docusign's ID for the account plan. |
planName | string | Optional | The name of the billing plan. |
seatDiscounts | array | Optional | A complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`. |
seatDiscounts[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan seat Discounts item |
supportIncidentFee | string | Optional | The support incident fee charged for each support incident. Example: `"$0.00"` |
supportPlanFee | string | Optional | The support plan fee charged for this plan. Example: `"$0.00"` |
Referenced models: Gets billing plan details — response body — billing Plan app Store Products item, Gets billing plan details — response body — billing Plan currency Plan Prices item, Get Account Billing Plan — response body — billing Plan plan Feature Sets item, Get Account Billing Plan — response body — billing Plan seat Discounts item
Gets billing plan details — response body — billing Plan app Store Products item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an APP store product. |
marketPlace | string | Optional | |
productId | string | Optional | The Product ID from the AppStore. |
Get Account Billing Plan — response body — billing Plan plan Feature Sets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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 | array | Optional | Reserved for Docusign. |
currencyFeatureSetPrices[] | Model | Each item | Expand Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item |
envelopeFee | string | Optional | Reserved for Docusign. |
featureSetId | string | Optional | Reserved for Docusign. |
fixedFee | string | Optional | Reserved for Docusign. |
is21CFRPart11 | string | Optional | Reserved for Docusign. |
isActive | string | Optional | Reserved for Docusign. |
isEnabled | string | Optional | When **true,** the feature set is actively enabled as part of the plan. |
name | string | Optional | Reserved for Docusign. |
seatFee | string | Optional | Reserved for Docusign. |
Referenced models: Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
Get Account Billing Plan — response body — billing Plan seat Discounts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a seat discount. |
beginSeatCount | string | Optional | Reserved for Docusign. |
discountPercent | string | Optional | The percent of the discount. Example: `"0.00"` |
endSeatCount | string | Optional | Reserved for Docusign. |
Gets billing plan details — response body — billing Plan currency Plan Prices item supported Card Types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardTypes | array | Optional | An array containing supported credit card types. |
cardTypes[] | string | Each item |
Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the price and currency associated with the feature set. Reserved for internal Docusign use only. |
currencyCode | string | Optional | Specifies the alternate ISO currency code for the account. |
currencySymbol | string | Optional | Reserved for Docusign. |
envelopeFee | string | Optional | Reserved for Docusign. |
fixedFee | string | Optional | Reserved for Docusign. |
seatFee | string | Optional | Reserved for Docusign. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_billingplans_getbillingplans. Catalog operation: esignature:BillingPlans_GetBillingPlans. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.