DocuSign: Get information about plan items within an organization
DocuSign admin.adminOrganizationSubAccountGetOrganizationPlanItems: arguments, response, policy and SDK examples.
← Admin operations · Get started
Operation docusign.admin_organizationsubaccount_getorganizationplanitems
Provider route: GET /Management/v2/organizations/{organizationId}/planItems. 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["admin"]["adminOrganizationSubAccountGetOrganizationPlanItems"]>[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.admin.adminOrganizationSubAccountGetOrganizationPlanItems(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.admin.admin_organization_sub_account_get_organization_plan_items(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.organizationId | string | Required within parent | Format: uuid |
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 |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand Get information about plan items within an organization — response body — item |
Referenced models: Get information about plan items within an organization — response body — item
Schemas
Section titled “Schemas”Get information about plan items within an organization — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
asset_group_id | string | Optional | Format: uuid |
asset_group_name | string | Optional | |
associated_accounts_count | JSON | Optional | |
associated_accounts_count (anyOf 1) | integer | Alternative | Format: int32 |
associated_accounts_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
modules | array | Optional | List of module IDs selected for creating the new account |
modules[] | Model | Each item | Expand Get information about plan items within an organization — response body — item modules item |
plan_id | string | Optional | Format: uuid |
plan_name | string | Optional | |
subscription_id | string | Optional | |
subscription_name | string | Optional |
Referenced models: Get information about plan items within an organization — response body — item modules item
Get information about plan items within an organization — response body — item modules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
plan_item_description | string | Optional | |
plan_item_id | string | Optional | Format: uuid |
plan_item_internal_id | string | Optional | |
plan_item_name | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.admin_organizationsubaccount_getorganizationplanitems. Catalog operation: admin:OrganizationSubAccount_GetOrganizationPlanItems. 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.
Required provider scopes: ["organization_sub_account_read"]