Skip to main content
object

Requires read_payment_terms access scope.

Represents the payment terms for an order or draft order.

Anchor to Fields and connectionsFields and connections

•

The draft order associated with the payment terms.

•
Boolean!non-null

Whether payment terms have a payment schedule that's due.

•

Duration of payment terms in days based on the payment terms template used to create the payment terms.

•
ID!non-null

A globally-unique ID.

•

The order associated with the payment terms.

•
Boolean!non-null

Whether the payment terms have overdue payment schedules.

•

List of schedules for the payment terms.

•
String!non-null

The name of the payment terms template used to create the payment terms.

•

The payment terms template type used to create the payment terms.

•
String!non-null

The payment terms name, translated into the shop admin's preferred language.


Was this section helpful?

•
mutation

Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput.

Arguments

Anchor to paymentTermsAttributespaymentTermsAttributes
•

The attributes used to create the payment terms.

•
ID!required

Specifies the reference orderId to add the payment terms for.


Fields

•

The created payment terms.

•

The list of errors that occurred from executing the mutation.

•
mutation

Update payment terms on an order. To update payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput.

Arguments

•

The input fields used to update the payment terms.


Fields

•

The updated payment terms.

•

The list of errors that occurred from executing the mutation.


Was this section helpful?

•
interface

Was this section helpful?