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.
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"]["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 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_plan_get_billing_plan(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.include_credit_card_information | string | Optional | |
query.include_downgrade_information | string | Optional | |
query.include_metadata | string | Optional | |
query.include_successor_plans | string | Optional | |
query.include_tax_exempt_id | string | Optional |
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 Get Account Billing Plan — response body |
Referenced models: Get Account Billing Plan — response body
Schemas
Section titled “Schemas”15 more schemas are linked from the tables above, on the schema pages.
Get Account Billing Plan — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines an account billing plan response object. |
billingAddress | Model | Optional | Expand Get Account Billing Plan — response body — billing Address The billing address for the account. |
billingAddressIsCreditCardAddress | string | Optional | When **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. |
billingPlan | Model | Optional | Expand Get Account Billing Plan — response body — billing Plan An object that contains details about the billing plan. |
creditCardInformation | Model | Optional | Expand Get credit card information — response body A complex type that has information about the credit card used to pay for this account. |
directDebitProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — direct Debit Processor Information Information about the bank that processes direct debits for the payment plan. |
downgradePlanInformation | Model | Optional | Expand Queues downgrade billing plan request for an account — response body |
downgradeRequestInformation | Model | Optional | Expand Get Account Billing Plan — response body — downgrade Request Information |
entityInformation | Model | Optional | Expand Get Account Billing Plan — response body — entity Information |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
paymentProcessorInformation | Model | Optional | Expand Get Account Billing Plan — response body — payment Processor Information Information about the entity that processes payments for the billing plan. |
referralInformation | Model | Optional | Expand Get Account Billing Plan — response body — referral Information A complex type that contains properties for entering referral and discount information. |
successorPlans | array | Optional | A list of billing plans that the current billing plan can be rolled into. |
successorPlans[] | Model | Each item | Expand Gets billing plan details — response body — billing Plan |
taxExemptId | string | Optional |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the address associated with the account. |
address1 | string | Optional | The first line of the address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the address. Maximum length: 100 characters. |
city | string | Optional | The city associated with the address. Maximum length: 40 characters. |
country | string | Optional | The country associated with the address. Maximum length: 50 characters. |
email | string | Optional | The email address associated with the account. |
fax | string | Optional | The fax number associated with the account. |
firstName | string | Optional | The first name of the user associated with the account. Maximum Length: 50 characters. |
lastName | string | Optional | The last name of the user associated with the account. |
phone | string | Optional | The phone number associated with the account. |
postalCode | string | Optional | The postal code associated with the address. Maximum length: 20 characters. |
state | string | Optional | The state or province associated with the address. Maximum length: 40 characters. |
supportedCountries | array | Optional | An array of supported countries associated with the account. |
supportedCountries[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billingProfile | string | Optional | The type of billing method on the account. Valid values are: - `direct` - `web` |
entityName | string | Optional | |
externalEntityId | string | Optional | |
isExternallyBilled | string | Optional |
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
Get Account Billing Plan — response body — downgrade Request Information
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
downgradeRequestCreation | string | Optional | |
downgradeRequestProductId | string | Optional | |
downgradeRequestStatus | string | Optional |
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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.