Choose a version:

paymentReminderSend

mutation

Requires write_orders access scope.

Sends an email payment reminder for a payment schedule.

Arguments

Anchor to paymentScheduleIdpaymentScheduleId •ID!required: The payment schedule id associated with the reminder.

Was this section helpful?

Anchor to PaymentReminderSendPayload returnsPaymentReminderSendPayload returns

Anchor to successsuccess •Boolean: Whether the payment reminder email was successfully sent.
Anchor to userErrorsuserErrors •[PaymentReminderSendUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Send a payment reminder
paymentReminderSend reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation paymentReminderSend($paymentScheduleId: ID!) {

paymentReminderSend(paymentScheduleId: $paymentScheduleId) {

success

userErrors {

message

}

}`,

{

variables: {

"paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"

);

const data = await response.json();

mutation paymentReminderSend($paymentScheduleId: ID!) {
  paymentReminderSend(paymentScheduleId: $paymentScheduleId) {
    success
    userErrors {
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation paymentReminderSend($paymentScheduleId: ID!) { paymentReminderSend(paymentScheduleId: $paymentScheduleId) { success userErrors { message } } }",
 "variables": {
    "paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation paymentReminderSend($paymentScheduleId: ID!) {
    paymentReminderSend(paymentScheduleId: $paymentScheduleId) {
      success
      userErrors {
        message
      }
    }
  }`,
  {
    variables: {
      "paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation paymentReminderSend($paymentScheduleId: ID!) {
      paymentReminderSend(paymentScheduleId: $paymentScheduleId) {
        success
        userErrors {
          message
        }
      }
    }`,
    "variables": {
      "paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"
    },
  },
});

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 paymentReminderSend($paymentScheduleId: ID!) {
    paymentReminderSend(paymentScheduleId: $paymentScheduleId) {
      success
      userErrors {
        message
      }
    }
  }
QUERY

variables = {
  "paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"
}

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

Input variables

JSON

{

"paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"

}

Response

JSON

{

"paymentReminderSend": {

"success": true,

"userErrors": []

}