Payments: list

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.1/accounts/{accountId}/billing_payments

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
from_datestring

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

to_datestring

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

Responses

CodeDescriptionReference
200

Successful response.

billingPaymentsResponse
400

Error encountered.

errorDetails

SDK Method

Billing::listPayments

Definitions

billingPaymentsResponse

Defines a billing payments response object.

billingPayments[Payments]

Reserved: TBD

nextUristring

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.

previousUristring

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.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

Payments

Payments

amountstring

Reserved: TBD

descriptionstring

A sender-defined description of the line item.

paymentDatestring

paymentIdstring

paymentNumberstring

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

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> 
}} />