---
title: >-
  New balance and due status fields for PaymentSchedule - Shopify developer
  changelog
description: >-
  Shopify’s developer changelog documents all changes to Shopify’s platform.
  Find the latest news and learn about new platform opportunities.
source_url:
  html: >-
    https://shopify.dev/changelog/posts/new-balance-and-due-status-fields-for-paymentschedule
  md: >-
    https://shopify.dev/changelog/posts/new-balance-and-due-status-fields-for-paymentschedule.md
metadata:
  effectiveApiVersion: 2025-10
  affectedApi:
    - displayName: Admin GraphQL API
      handle: admin-graphql
    - displayName: Customer Account API
      handle: customer-account-graphql
  primaryTag:
    displayName: API
    handle: api
  secondaryTag:
    displayName: New
    handle: new
  indicatesActionRequired: false
  createdAt: '2025-09-09T18:37:19-04:00'
  postedAt: '2025-09-17T12:00:00-04:00'
  updatedAt: '2025-09-10T09:42:53-04:00'
  effectiveAt: '2025-09-17T12:00:00-04:00'
---

September 17, 2025

# New balance and due status fields for PaymentSchedule

DateSeptember 17, 2025

Version[2025-10](https://shopify.dev/changelog?api_version=2025-10)

FlagsNew

SurfacesAPI

Affected APIs[Admin GraphQL API](https://shopify.dev/changelog?api_type=admin-graphql)[Customer Account API](https://shopify.dev/changelog?api_type=customer-account-graphql)

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 `Order.totalOutstandingSet` for order-level balance details.