Skip to content

DocuSign: Get Account Billing Plan

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

← Esignature operations · Get started

Operation docusign.esignature_billingplan_getbillingplan

Provider route: GET /restapi/v2.1/accounts/{accountId}/billing_plan. 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"]["esignatureBillingPlanGetBillingPlan"]>[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.esignatureBillingPlanGetBillingPlan(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_plan_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.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.include_credit_card_informationstringOptional
query.include_downgrade_informationstringOptional
query.include_metadatastringOptional
query.include_successor_plansstringOptional
query.include_tax_exempt_idstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Account Billing Plan — response body

Referenced models: Get Account Billing Plan — response body

15 more schemas are linked from the tables above, on the schema pages.

Get Account Billing Plan — response body
FieldTypePresenceDescription and constraints
$objectRootDefines an account billing plan response object.
billingAddressModelOptionalExpand Get Account Billing Plan — response body — billing Address
The billing address for the account.
billingAddressIsCreditCardAddressstringOptionalWhen **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.
billingPlanModelOptionalExpand Get Account Billing Plan — response body — billing Plan
An object that contains details about the billing plan.
creditCardInformationModelOptionalExpand Get credit card information — response body
A complex type that has information about the credit card used to pay for this account.
directDebitProcessorInformationModelOptionalExpand Get Account Billing Plan — response body — direct Debit Processor Information
Information about the bank that processes direct debits for the payment plan.
downgradePlanInformationModelOptionalExpand Queues downgrade billing plan request for an account — response body
downgradeRequestInformationModelOptionalExpand Get Account Billing Plan — response body — downgrade Request Information
entityInformationModelOptionalExpand Get Account Billing Plan — response body — entity Information
paymentMethodstringOptionalThe payment method used for the billing plan. Valid values are:

- `NotSupported`
- `CreditCard`
- `PurchaseOrder`
- `Premium`
- `Freemium`
- `FreeTrial`
- `AppStore`
- `DigitalExternal`
- `DirectDebit`
paymentProcessorInformationModelOptionalExpand Get Account Billing Plan — response body — payment Processor Information
Information about the entity that processes payments for the billing plan.
referralInformationModelOptionalExpand Get Account Billing Plan — response body — referral Information
A complex type that contains properties for entering referral and discount information.
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
taxExemptIdstringOptional

Referenced models: Get Account Billing Plan — response body — billing Address, Get Account Billing Plan — response body — billing Plan, Get Account Billing Plan — response body — entity Information, Gets billing plan details — response body — billing Plan, Get credit card information — response body, Get Account Billing Plan — response body — direct Debit Processor Information, Queues downgrade billing plan request for an account — response body, Get Account Billing Plan — response body — downgrade Request Information, Get Account Billing Plan — response body — payment Processor Information, Get Account Billing Plan — response body — referral Information

Get Account Billing Plan — response body — billing Address
FieldTypePresenceDescription and constraints
$objectRootContains information about the address associated with the account.
address1stringOptionalThe first line of the address. Maximum length: 100 characters.
address2stringOptionalThe second line of the address. Maximum length: 100 characters.
citystringOptionalThe city associated with the address. Maximum length: 40 characters.
countrystringOptionalThe country associated with the address. Maximum length: 50 characters.
emailstringOptionalThe email address associated with the account.
faxstringOptionalThe fax number associated with the account.
firstNamestringOptionalThe first name of the user associated with the account. Maximum Length: 50 characters.
lastNamestringOptionalThe last name of the user associated with the account.
phonestringOptionalThe phone number associated with the account.
postalCodestringOptionalThe postal code associated with the address. Maximum length: 20 characters.
statestringOptionalThe state or province associated with the address. Maximum length: 40 characters.
supportedCountriesarrayOptionalAn array of supported countries associated with the account.
supportedCountries[]ModelEach itemExpand Get Account Billing Plan — response body — billing Address supported Countries item

Referenced models: Get Account Billing Plan — response body — billing Address supported Countries item

Get Account Billing Plan — response body — entity Information
FieldTypePresenceDescription and constraints
$objectRoot
billingProfilestringOptionalThe type of billing method on the account. Valid values are:

- `direct`
- `web`
entityNamestringOptional
externalEntityIdstringOptional
isExternallyBilledstringOptional
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

Get Account Billing Plan — response body — downgrade Request Information
FieldTypePresenceDescription and constraints
$objectRoot
downgradeRequestCreationstringOptional
downgradeRequestProductIdstringOptional
downgradeRequestStatusstringOptional
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.

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