v1

latestSwagger 2.02026-07-134146194.6 MB
Payments

Posts a payment to a past due invoice.

Posts a payment to a past due invoice.

This method can only be used if the paymentAllowed value for a past due invoice is true. This can be determined calling Billing::listInvoicesPastDue.

The response returns information for a single payment if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days.

If the request was for a single payment ID, the nextUri and previousUri properties are not returned.

Privileges required: account administrator

post/v2.1/accounts/{accountId}/billing_payments

Path parameters

accountIdstring required

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

Request body

paymentAmountstring

The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices.

Response

Successful response.