Tags:
- Admin GraphQL API
- Customer Account API
- 2025-10
New balance and due status fields for PaymentSchedule
You can now access more detailed balance information and payment status updates for payment schedules using deferred payments.
We've introduced three new fields to the PaymentSchedule object:
- 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: Indicates whether the payment schedule is currently due (boolean).
These fields enhance your ability to monitor payment statuses when developing apps for merchants utilizing payment terms and deferred payment options. With these updates, you can easily differentiate between captured and uncaptured balances and quickly identify which payment schedules require immediate action.
Please note that the existing amount
field is now deprecated. We recommend using these new fields for more specific information, or you can refer to for order-level balance details.
Was this section helpful?