We’re excited to introduce new enhancements to the PaymentSchedule object that provide better visibility into payment statuses and balances. These updates are especially valuable for developers building apps for merchants using deferred payment terms.
New Fields in PaymentSchedule
The PaymentSchedule object now includes three new fields:
- balanceDue: The remaining balance that needs to be captured for this payment schedule.
- totalBalance: The total balance that the customer needs to pay or authorize for this payment schedule.
- due: A boolean value that indicates whether the payment schedule is currently due.
Benefits of the Update
These new fields offer several advantages for developers:
- Improved ability to differentiate between captured and uncaptured balances.
- Clear identification of payment schedules requiring immediate action.
- More specific balance information compared to the deprecated
amountfield.
Important Note
The amount field in the PaymentSchedule object is now deprecated. We recommend transitioning to the new fields for more detailed and actionable data. Alternatively, you can use Order.totalOutstandingSet for order-level balance details.
By incorporating these changes, developers can create more efficient and responsive apps for merchants managing payment schedules.