DocuSign: Get credit card information
DocuSign esignature.esignatureBillingPlanGetCreditCardInfo: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_billingplan_getcreditcardinfo
Provider route: GET /restapi/v2.1/accounts/{accountId}/billing_plan/credit_card. 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"]["esignatureBillingPlanGetCreditCardInfo"]>[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.esignatureBillingPlanGetCreditCardInfo(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_credit_card_info(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 |
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 credit card information — response body |
Referenced models: Get credit card information — response body
Schemas
Section titled “Schemas”Get credit card information — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a credit card that is associated with an account. |
address | Model | Optional | Expand Get credit card information — response body — address A complex element containing the credit card billing address information. |
cardLastDigits | string | Optional | |
cardNumber | string | Optional | The credit card number. |
cardType | string | Optional | The type of credit card. Valid values are: - `visa` - `mastercard` - `amex` |
cvNumber | string | Optional | The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs). |
expirationMonth | string | Optional | The month that the credit card expires, expressed as a number from 1 to 12. |
expirationYear | string | Optional | The year in which the credit card expires, in 4-digit format. |
nameOnCard | string | Optional | The exact name as it appears on the credit card. |
tokenizedCard | string | Optional |
Referenced models: Get credit card information — response body — address
Get credit card information — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains address information. |
address1 | string | Optional | The first line of the user's address. Maximum length: 100 characters. |
address2 | string | Optional | The second line of the user's address. Maximum length: 100 characters. |
city | string | Optional | The user's city. Maximum length: 40 characters. |
country | string | Optional | The user's country. Maximum length: 50 characters. |
fax | string | Optional | A fax number associated with the address, if one is available. |
phone | string | Optional | A phone number associated with the address. |
postalCode | string | Optional | The user's postal code. Maximum length: 20 characters. |
stateOrProvince | string | Optional | The user's state or province. Maximum length: 40 characters. |
zipPlus4 | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_billingplan_getcreditcardinfo. Catalog operation: esignature:BillingPlan_GetCreditCardInfo. 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.