Skip to content

DocuSign: Gets payment information for one or more payments

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

← Esignature operations · Get started

Operation docusign.esignature_billingpayments_getpaymentlist

Provider route: GET /restapi/v2.1/accounts/{accountId}/billing_payments. 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"]["esignatureBillingPaymentsGetPaymentList"]>[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.esignatureBillingPaymentsGetPaymentList(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_payments_get_payment_list(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.from_datestringOptional
query.to_datestringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets payment information for one or more payments — response body

Referenced models: Gets payment information for one or more payments — response body

Gets payment information for one or more payments — response body
FieldTypePresenceDescription and constraints
$objectRootDefines a billing payments response object.
billingPaymentsarrayOptionalReserved for Docusign.
billingPayments[]ModelEach itemExpand Gets billing payment information for a specific payment — response body
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.

Referenced models: Gets billing payment information for a specific payment — response body

Gets billing payment information for a specific payment — response body
FieldTypePresenceDescription and constraints
$objectRootDefines a billing payment request object.
amountstringOptionalThe total amount of the purchase.
descriptionstringOptionalA sender-defined description of the line item.
paymentDatestringOptional
paymentIdstringOptionalThe ID of the payment.
paymentNumberstringOptionalWhen **true,** a PDF version of the invoice is available.

To get the PDF, make the call again and change "Accept:" in the header to "Accept: application/pdf".

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