Skip to navigation

Payments Resource

View as Markdown

The Payments resource provides methods that allow you to manage payments for an account.

These calls can only be used by users with account administrator privileges.

Methods supported

MethodDescription
createPOST /restapi/v2/accounts/{accountId}/billing_payments
Posts a payment to a past due invoice.
getGET /restapi/v2/accounts/{accountId}/billing_payments/{paymentId}
Gets billing payment information for a specific payment.
listGET /restapi/v2/accounts/{accountId}/billing_payments
Gets payment information for one or more payments.

Payments properties

PropertyTypeDescription
amountstringReserved: TBD
descriptionstring
paymentDatestring
paymentIdstring
paymentNumberstringWhen 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”.