Line Item Object

One or many of these objects is passed in when using the Line Item Payment Page endpoint

Field Name

Type

Description

paymentAmount

Decimal

The amount for the given line item. This amount will be shown as the total amount for the line item and defaulted as the amount to be paid off on that line item.

editable

Boolean

Default is True. If True, allows for edits to the amount to be made on the page. If False, then the amount provided in paymentAmount will be locked in place.

itemId

String

Value for itemId column. If none supplied for any line item on page, column won't appear.

itemName

String

Value for itemName column. If none supplied for any line item on page, column won't appear.

itemDescription

String

Value for itemDescription column. If none supplied for any line item on page, column won't appear.

"lineItems": [
    {
      "paymentAmount": 600,
      "editable": true,
      "itemId": "12345",
      "itemName": "Hourly Professional Services",
      "itemDescription": "Standard Hourly Rate"
    }
  ]