Skip to content

DocuSign: Gets billing plan details

DocuSign esignature.esignatureBillingPlansGetBillingPlan: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_billingplans_getbillingplan

Provider route: GET /restapi/v2.1/billing_plans/{billingPlanId}. Alter supplies the connection’s credentials and routing.

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"]["esignatureBillingPlansGetBillingPlan"]>[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.esignatureBillingPlansGetBillingPlan(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_plan(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.billingPlanIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets billing plan details — response body

Referenced models: Gets billing plan details — response body

1 more schema is linked from the tables above, on the schema pages.

Gets billing plan details — response body
FieldTypePresenceDescription and constraints
$objectRootDefines a billing plan response object.
billingPlanModelOptionalExpand Gets billing plan details — response body — billing Plan
An object that contains details about the billing plan.
successorPlansarrayOptionalA list of billing plans that the current billing plan can be rolled into.
successorPlans[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootContains information about a billing plan.
appStoreProductsarrayOptionalReserved for Docusign.
appStoreProducts[]ModelEach itemExpand Gets billing plan details — response body — billing Plan app Store Products item
currencyPlanPricesarrayOptionalContains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set.
currencyPlanPrices[]ModelEach itemExpand Gets billing plan details — response body — billing Plan currency Plan Prices item
enableSupportstringOptionalWhen **true,** customer support is provided as part of the account plan.
includedSeatsstringOptionalThe number of seats (users) included in the plan.
otherDiscountPercentstringOptionalAny other percentage discount for the plan.

Example: `"0.00"`
paymentCyclestringOptionalThe payment cycle associated with the plan. Valid values: Monthly or Annually.
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
perSeatPricestringOptionalThe per seat price for the plan.
planClassificationstringOptionalIdentifies the type of plan. Examples include:

- `business`
- `corporate`
- `enterprise`
- `free`
planFeatureSetsarrayOptionalReserved for Docusign.
planFeatureSets[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan plan Feature Sets item
planIdstringOptionalDocusign's ID for the account plan.
planNamestringOptionalThe name of the billing plan.
seatDiscountsarrayOptionalA complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`.
seatDiscounts[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan seat Discounts item
supportIncidentFeestringOptionalThe support incident fee charged for each support incident.

Example: `"$0.00"`
supportPlanFeestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootContains information about an APP store product.
marketPlacestringOptional
productIdstringOptionalThe Product ID from the AppStore.
Get Account Billing Plan — response body — billing Plan plan Feature Sets item
FieldTypePresenceDescription and constraints
$objectRootThis 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.
currencyFeatureSetPricesarrayOptionalReserved for Docusign.
currencyFeatureSetPrices[]ModelEach itemExpand Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
envelopeFeestringOptionalReserved for Docusign.
featureSetIdstringOptionalReserved for Docusign.
fixedFeestringOptionalReserved for Docusign.
is21CFRPart11stringOptionalReserved for Docusign.
isActivestringOptionalReserved for Docusign.
isEnabledstringOptionalWhen **true,** the feature set is actively enabled as part of the plan.
namestringOptionalReserved for Docusign.
seatFeestringOptionalReserved 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
FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a seat discount.
beginSeatCountstringOptionalReserved for Docusign.
discountPercentstringOptionalThe percent of the discount.

Example: `"0.00"`
endSeatCountstringOptionalReserved for Docusign.
Gets billing plan details — response body — billing Plan currency Plan Prices item supported Card Types
FieldTypePresenceDescription and constraints
$objectRoot
cardTypesarrayOptionalAn array containing supported credit card types.
cardTypes[]stringEach item
Get Account Billing Plan — response body — billing Plan plan Feature Sets item currency Feature Set Prices item
FieldTypePresenceDescription and constraints
$objectRootInformation about the price and currency associated with the feature set. Reserved for internal Docusign use only.
currencyCodestringOptionalSpecifies the alternate ISO currency code for the account.
currencySymbolstringOptionalReserved for Docusign.
envelopeFeestringOptionalReserved for Docusign.
fixedFeestringOptionalReserved for Docusign.
seatFeestringOptionalReserved for Docusign.

SDK function policy ID: docusign.esignature_billingplans_getbillingplan. Catalog operation: esignature:BillingPlans_GetBillingPlan. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.