Anchor to section titled 'undefined'payment
payment
mutation
2024-07
Requires write access scope.
Sends an email payment reminder for a payment schedule.
Anchor to section titled 'Arguments'
Arguments
The payment schedule id associated with the reminder.
Was this section helpful?
Anchor to section titled 'PaymentReminderSendPayload returns'
PaymentReminderSendPayload returns
Whether the payment reminder email was successfully sent.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: paymentReminderSend
Query Reference for MUTATION: paymentReminderSend
"mutation paymentReminderSend($paymentScheduleId: ID!) {\n paymentReminderSend(paymentScheduleId: $paymentScheduleId) {\n success\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: paymentReminderSend
"{\n \"paymentScheduleId\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: paymentReminderSend
""
Display Examples for MUTATION: paymentReminderSend
[
{
"example": {
"type_name": "paymentremindersend",
"title": "Send a payment reminder",
"description": "Send a payment reminder email to a customer.",
"query_string": "mutation paymentReminderSend($paymentScheduleId: ID!) {\n paymentReminderSend(paymentScheduleId: $paymentScheduleId) {\n success\n userErrors {\n message\n }\n }\n}",
"variables": {
"paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"
},
"response": {
"data": {
"paymentReminderSend": {
"success": true,
"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_reminder_send_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation paymentReminderSend($paymentScheduleId: ID!) { paymentReminderSend(paymentScheduleId: $paymentScheduleId) { success userErrors { message } } }\",\n \"variables\": {\n \"paymentScheduleId\": \"gid://shopify/PaymentSchedule/864539144\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation paymentReminderSend($paymentScheduleId: ID!) {\n paymentReminderSend(paymentScheduleId: $paymentScheduleId) {\n success\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"paymentScheduleId\": \"gid://shopify/PaymentSchedule/864539144\"\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 paymentReminderSend($paymentScheduleId: ID!) {\n paymentReminderSend(paymentScheduleId: $paymentScheduleId) {\n success\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"paymentScheduleId\": \"gid://shopify/PaymentSchedule/864539144\"\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 paymentReminderSend($paymentScheduleId: ID!) {\n paymentReminderSend(paymentScheduleId: $paymentScheduleId) {\n success\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"paymentScheduleId\": \"gid://shopify/PaymentSchedule/864539144\"\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 paymentReminderSend($paymentScheduleId: ID!) {\n paymentReminderSend(paymentScheduleId: $paymentScheduleId) {\n success\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"paymentScheduleId\" => \"gid://shopify/PaymentSchedule/864539144\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "paymentScheduleId",
"description": "The payment schedule id associated with the reminder.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "paymentScheduleId",
"argValue": " \"gid://shopify/PaymentSchedule/864539144\"",
"typeKind": "MUTATION"
}
]
}
]