PaymentSchedule

object

Requires read_payment_terms access scope.

Represents the payment schedule for a single payment defined in the payment terms.

Anchor to FieldsFields

Anchor to balanceDuebalanceDue • MoneyV2!non-null: Remaining balance to be captured for this payment schedule.
Anchor to completedAtcompletedAt • DateTime: Date and time when the payment schedule is paid or fulfilled.
Anchor to duedue • Boolean!non-null: Whether the payment schedule is due.
Anchor to dueAtdueAt • DateTime: Date and time when the payment schedule is due.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to issuedAtissuedAt • DateTime: Date and time when the invoice is sent.
Anchor to paymentTermspaymentTerms • PaymentTerms!non-null: The payment terms the payment schedule belongs to.
Anchor to totalBalancetotalBalance • MoneyV2!non-null: Remaining balance to be paid or authorized by the customer for this payment schedule.
Anchor to amountamount • MoneyV2!non-nullDeprecated: Amount owed for this payment schedule. Use balanceDue, totalBalance, or Order.totalOutstandingSet instead.

Was this section helpful?

Was this section helpful?