paymentTermsUpdate

mutation

Requires write_payment_terms access scope. Also: User must have either orders or draft orders access according to the reference.

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

Anchor to inputinput • PaymentTermsUpdateInput!required: The input fields used to update the payment terms.

Was this section helpful?

Anchor to PaymentTermsUpdatePayload returnsPaymentTermsUpdatePayload returns

Anchor to paymentTermspaymentTerms • PaymentTerms: The updated payment terms.
Anchor to userErrorsuserErrors • [PaymentTermsUpdateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Update payment terms date
Update payment terms type
paymentTermsUpdate reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {

paymentTermsUpdate(input: $input) {

paymentTerms {

}

userErrors {

code

field

message

}

}`,

{

variables: {

"input": {

"paymentTermsId": "gid://shopify/PaymentTerms/977822362",

"paymentTermsAttributes": {

"paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",

"paymentSchedules": [

{

"dueAt": "2022-06-13T22:35:23.311Z"

mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {
  paymentTermsUpdate(input: $input) {
    paymentTerms {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) { paymentTermsUpdate(input: $input) { paymentTerms { id } userErrors { code field message } } }",
 "variables": {
    "input": {
      "paymentTermsId": "gid://shopify/PaymentTerms/977822362",
      "paymentTermsAttributes": {
        "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
        "paymentSchedules": [
          {
            "dueAt": "2022-06-13T22:35:23.311Z"
          }
        ]
      }
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {
    paymentTermsUpdate(input: $input) {
      paymentTerms {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "paymentTermsId": "gid://shopify/PaymentTerms/977822362",
        "paymentTermsAttributes": {
          "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
          "paymentSchedules": [
            {
              "dueAt": "2022-06-13T22:35:23.311Z"
            }
          ]
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {
      paymentTermsUpdate(input: $input) {
        paymentTerms {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "paymentTermsId": "gid://shopify/PaymentTerms/977822362",
        "paymentTermsAttributes": {
          "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
          "paymentSchedules": [
            {
              "dueAt": "2022-06-13T22:35:23.311Z"
            }
          ]
        }
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {
    paymentTermsUpdate(input: $input) {
      paymentTerms {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "paymentTermsId": "gid://shopify/PaymentTerms/977822362",
    "paymentTermsAttributes": {
      "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
      "paymentSchedules": [{"dueAt"=>"2022-06-13T22:35:23.311Z"}]
    }
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"paymentTermsId": "gid://shopify/PaymentTerms/977822362",

"paymentTermsAttributes": {

"paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",

"paymentSchedules": [

{

"dueAt": "2022-06-13T22:35:23.311Z"

}

]

}

Response

JSON

{

"paymentTermsUpdate": {

"paymentTerms": {

"id": "gid://shopify/PaymentTerms/977822362"

"userErrors": []

}