Skip to content

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.

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 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_credit_card_info(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get credit card information — response body

Referenced models: Get credit card information — response body

Get credit card information — response body
FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a credit card that is associated with an account.
addressModelOptionalExpand Get credit card information — response body — address
A complex element containing the credit card billing address information.
cardLastDigitsstringOptional
cardNumberstringOptionalThe credit card number.
cardTypestringOptionalThe type of credit card. Valid values are:

- `visa`
- `mastercard`
- `amex`
cvNumberstringOptionalThe 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).
expirationMonthstringOptionalThe month that the credit card expires, expressed as a number from 1 to 12.
expirationYearstringOptionalThe year in which the credit card expires, in 4-digit format.
nameOnCardstringOptionalThe exact name as it appears on the credit card.
tokenizedCardstringOptional

Referenced models: Get credit card information — response body — address

Get credit card information — response body — address
FieldTypePresenceDescription and constraints
$objectRootContains address information.
address1stringOptionalThe first line of the user's address.
Maximum length: 100 characters.
address2stringOptionalThe second line of the user's address.
Maximum length: 100 characters.
citystringOptionalThe user's city. Maximum length: 40 characters.
countrystringOptionalThe user's country. Maximum length: 50 characters.
faxstringOptionalA fax number associated with the address, if one is available.
phonestringOptionalA phone number associated with the address.
postalCodestringOptionalThe user's postal code. Maximum length: 20 characters.
stateOrProvincestringOptionalThe user's state or province. Maximum length: 40 characters.
zipPlus4stringOptional

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.

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.