Payment
Requires access scope.
Payment conditions for an Order or , including when payment is due and how it's scheduled. Payment terms are created from templates that specify net terms (payment due after a certain number of days) or fixed schedules with specific due dates. You can optionally provide custom payment schedules using .
Each payment term contains one or more , which you can access through the field. Payment schedules contain detailed information for each payment installment.
Learn more about payment terms.
Anchor to FieldsFields
- Anchor to draftOrderdraft•Draft
Order Order The draft order associated with the payment terms.
- •Boolean!non-null
Whether payment terms have a payment schedule that's due.
- Anchor to dueInDaysdue•Int
In Days 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.
- Anchor to orderorder•Order
The order associated with the payment terms.
- Anchor to overdueoverdue•Boolean!non-null
Whether the payment terms have overdue payment schedules.
- Anchor to paymentSchedulespayment•Payment
Schedules Schedule Connection! non-null List of schedules for the payment terms.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to paymentTermsNamepayment•String!
Terms Name non-null The name of the payment terms template used to create the payment terms.
- Anchor to paymentTermsTypepayment•Payment
Terms Type Terms Type! non-null The payment terms template type used to create the payment terms.
- Anchor to translatedNametranslated•String!
Name non-null The payment terms name, translated into the shop admin's preferred language.
Anchor to MutationsMutations
- •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
.- Anchor to referenceIdreference•ID!
Id required Specifies the reference orderId to add the payment terms for.
- Anchor to paymentTermsAttributespayment•Payment
Terms Attributes Terms Create Input! required The attributes used to create the payment terms.
Arguments
- •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
.- Anchor to inputinput•Payment
Terms Update Input! required The input fields used to update the payment terms.
Arguments