Payments

Posts a payment to a past due invoice

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

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

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Request Body

application/json

paymentAmount?string

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

Response Body

application/json

application/json

curl -X POST "https://example.com/v2.1/accounts/string/billing_payments" \  -H "Content-Type: application/json" \  -d '{}'
{  "billingPayments": [    {      "amount": "string",      "invoiceId": "string",      "paymentId": "string"    }  ]}