Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.

Privileges required: account administrator

Request

HTTP request

GET /v2/accounts/{accountId}/billing_payments

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

Optional query parameters
from_date string

Specifies the date/time of the earliest payment in the account to retrieve.

to_date string

Specifies the date/time of the latest payment in the account to retrieve.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Billing::listPayments

Definitions Expand All | Collapse All

Payments

Payments

amount string

Reserved: TBD

description string

A sender-defined description of the line item.

paymentDate string
paymentId string
paymentNumber string

When set to 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".

billingPaymentsResponse

Defines a billing payments response object.

billingPayments
[Payments]

Reserved: TBD

nextUri string

The 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.

previousUri string

The 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.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Response

Response

{
"billingPayments": [
{
"paymentId": "sample string 1",
"amount": "sample string 2",
"paymentDate": "sample string 3",
"paymentNumber": "sample string 4",
"description": "sample string 5"
}
]
,
"nextUri": "sample string 1",
"previousUri": "sample string 2"
}

Generic XML Response

Response

<billingPaymentsResponse 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<billingPayments>
<billingPaymentItem>
<amount>sample string 2</amount>
<description>sample string 5</description>
<paymentDate>sample string 3</paymentDate>
<paymentId>sample string 1</paymentId>
<paymentNumber>sample string 4</paymentNumber>
</billingPaymentItem>
</billingPayments>
<nextUri>sample string 1</nextUri>
<previousUri>sample string 2</previousUri>
</billingPaymentsResponse>