Anchor to section titled 'undefined'payment
payment
mutation
2024-04
Requires write 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 Draft.
Anchor to section titled 'Arguments'
Arguments
The input fields used to update the payment terms.
Was this section helpful?
Anchor to section titled 'PaymentTermsUpdatePayload returns'
PaymentTermsUpdatePayload returns
The updated payment terms.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: paymentTermsUpdate
Query Reference for MUTATION: paymentTermsUpdate
"mutation paymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n # PaymentTerms fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: paymentTermsUpdate
"{\n \"input\": {\n \"paymentTermsAttributes\": {\n \"paymentSchedules\": [\n {\n \"dueAt\": \"2019-09-07T15:50:00Z\",\n \"issuedAt\": \"2019-09-07T15:50:00Z\"\n }\n ],\n \"paymentTermsTemplateId\": \"gid://shopify/<objectName>/10079785100\"\n },\n \"paymentTermsId\": \"gid://shopify/<objectName>/10079785100\"\n }\n}"Schema Reference for MUTATION: paymentTermsUpdate
"input PaymentTermsUpdateInput {\n paymentTermsAttributes: PaymentTermsInput!\n paymentTermsId: ID!\n}\n\ninput PaymentTermsInput {\n paymentSchedules: [PaymentScheduleInput!]\n paymentTermsTemplateId: ID\n}\n"Display Examples for MUTATION: paymentTermsUpdate
[
{
"example": {
"type_name": "paymenttermsupdate",
"title": "Update payment terms date",
"description": "Update the due date for fixed date payment terms.",
"query_string": "mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}",
"variables": {
"input": {
"paymentTermsId": "gid://shopify/PaymentTerms/977822362",
"paymentTermsAttributes": {
"paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7",
"paymentSchedules": [
{
"dueAt": "2022-06-13T22:35:23.311Z"
}
]
}
}
},
"response": {
"data": {
"paymentTermsUpdate": {
"paymentTerms": {
"id": "gid://shopify/PaymentTerms/977822362"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/payments/payment_flexibility/test/unit/graph_api/admin/mutations/payment_terms_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) { paymentTermsUpdate(input: $input) { paymentTerms { id } userErrors { code field message } } }\",\n \"variables\": {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n \"paymentSchedules\": [\n {\n \"dueAt\": \"2022-06-13T22:35:23.311Z\"\n }\n ]\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n \"paymentSchedules\": [\n {\n \"dueAt\": \"2022-06-13T22:35:23.311Z\"\n }\n ]\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n \"paymentSchedules\": [{\"dueAt\"=>\"2022-06-13T22:35:23.311Z\"}]\n }\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/7\",\n \"paymentSchedules\": [\n {\n \"dueAt\": \"2022-06-13T22:35:23.311Z\"\n }\n ]\n }\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"paymentTermsId\" => \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\" => [\n \"paymentTermsTemplateId\" => \"gid://shopify/PaymentTermsTemplate/7\",\n \"paymentSchedules\" => [{\"dueAt\"=>\"2022-06-13T22:35:23.311Z\"}],\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input fields used to update the payment terms.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PaymentTermsUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "PaymentTermsUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"paymentTermsId\":\"gid://shopify/PaymentTerms/977822362\",\"paymentTermsAttributes\":{\"paymentTermsTemplateId\":\"gid://shopify/PaymentTermsTemplate/7\",\"paymentSchedules\":[{\"dueAt\":\"2022-06-13T22:35:23.311Z\"}]}}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "paymenttermsupdate",
"title": "Update payment terms type",
"description": "Change payment terms to net terms.",
"query_string": "mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}",
"variables": {
"input": {
"paymentTermsId": "gid://shopify/PaymentTerms/977822362",
"paymentTermsAttributes": {
"paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2",
"paymentSchedules": [
{
"issuedAt": "2022-06-13T22:35:23.311Z"
}
]
}
}
},
"response": {
"data": {
"paymentTermsUpdate": {
"paymentTerms": {
"id": "gid://shopify/PaymentTerms/977822362"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/payments/payment_flexibility/test/unit/graph_api/admin/mutations/payment_terms_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) { paymentTermsUpdate(input: $input) { paymentTerms { id } userErrors { code field message } } }\",\n \"variables\": {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n \"paymentSchedules\": [\n {\n \"issuedAt\": \"2022-06-13T22:35:23.311Z\"\n }\n ]\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n \"paymentSchedules\": [\n {\n \"issuedAt\": \"2022-06-13T22:35:23.311Z\"\n }\n ]\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n \"paymentSchedules\": [{\"issuedAt\"=>\"2022-06-13T22:35:23.311Z\"}]\n }\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"paymentTermsId\": \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\": {\n \"paymentTermsTemplateId\": \"gid://shopify/PaymentTermsTemplate/2\",\n \"paymentSchedules\": [\n {\n \"issuedAt\": \"2022-06-13T22:35:23.311Z\"\n }\n ]\n }\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation PaymentTermsUpdate($input: PaymentTermsUpdateInput!) {\n paymentTermsUpdate(input: $input) {\n paymentTerms {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"paymentTermsId\" => \"gid://shopify/PaymentTerms/977822362\",\n \"paymentTermsAttributes\" => [\n \"paymentTermsTemplateId\" => \"gid://shopify/PaymentTermsTemplate/2\",\n \"paymentSchedules\" => [{\"issuedAt\"=>\"2022-06-13T22:35:23.311Z\"}],\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input fields used to update the payment terms.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PaymentTermsUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "PaymentTermsUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"paymentTermsId\":\"gid://shopify/PaymentTerms/977822362\",\"paymentTermsAttributes\":{\"paymentTermsTemplateId\":\"gid://shopify/PaymentTermsTemplate/2\",\"paymentSchedules\":[{\"issuedAt\":\"2022-06-13T22:35:23.311Z\"}]}}",
"typeKind": "MUTATION"
}
]
}
]