# paymentReminderSend - admin - MUTATION
Version: 2025-01

## Description
Sends an email payment reminder for a payment schedule.

### Access Scopes
`write_orders` access scope.


## Arguments
* [paymentScheduleId](/docs/api/admin/2025-01/scalars/ID): ID! - The payment schedule id associated with the reminder.


## Returns
* [success](/docs/api/admin/2025-01/scalars/Boolean): Boolean Whether the payment reminder email was successfully sent.
* [userErrors](/docs/api/admin/2025-01/objects/PaymentReminderSendUserError): PaymentReminderSendUserError! The list of errors that occurred from executing the mutation.


## Examples
### Send a payment reminder
Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/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"
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"
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" 
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"
Graphql query: "mutation paymentReminderSend($paymentScheduleId: ID!) {\n  paymentReminderSend(paymentScheduleId: $paymentScheduleId) {\n    success\n    userErrors {\n      message\n    }\n  }\n}"
#### Graphql Input
{
  "paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"
}
#### Graphql Response
{
  "data": {
    "paymentReminderSend": {
      "success": true,
      "userErrors": []
    }
  }
}