# paymentTermsUpdate - admin-graphql - MUTATION Version: 2024-10 ## Description 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`. ### Access Scopes `write_payment_terms` access scope. Also: User must have either orders or draft orders access according to the reference. ## Arguments * [input](/docs/api/admin-graphql/2024-10/input-objects/PaymentTermsUpdateInput): PaymentTermsUpdateInput! - The input fields used to update the payment terms. ## Returns * [paymentTerms](/docs/api/admin-graphql/2024-10/objects/PaymentTerms): PaymentTerms The updated payment terms. * [userErrors](/docs/api/admin-graphql/2024-10/objects/PaymentTermsUpdateUserError): PaymentTermsUpdateUserError! The list of errors that occurred from executing the mutation. ## Examples ### Update payment terms date Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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" 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" 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" 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" Graphql 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}" #### Graphql Input { "input": { "paymentTermsId": "gid://shopify/PaymentTerms/977822362", "paymentTermsAttributes": { "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/7", "paymentSchedules": [ { "dueAt": "2022-06-13T22:35:23.311Z" } ] } } } #### Graphql Response { "data": { "paymentTermsUpdate": { "paymentTerms": { "id": "gid://shopify/PaymentTerms/977822362" }, "userErrors": [] } } } ### Update payment terms type Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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" 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" 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" 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" Graphql 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}" #### Graphql Input { "input": { "paymentTermsId": "gid://shopify/PaymentTerms/977822362", "paymentTermsAttributes": { "paymentTermsTemplateId": "gid://shopify/PaymentTermsTemplate/2", "paymentSchedules": [ { "issuedAt": "2022-06-13T22:35:23.311Z" } ] } } } #### Graphql Response { "data": { "paymentTermsUpdate": { "paymentTerms": { "id": "gid://shopify/PaymentTerms/977822362" }, "userErrors": [] } } }