Anchor to section titled 'undefined'

paymentReminderSend
mutation

Requires write_orders access scope.

Sends an email payment reminder for a payment schedule.


Anchor to paymentScheduleId
paymentScheduleId
required

The payment schedule id associated with the reminder.


Was this section helpful?

Whether the payment reminder email was successfully sent.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation paymentReminderSend($paymentScheduleId: ID!) {
  paymentReminderSend(paymentScheduleId: $paymentScheduleId) {
    success
    userErrors {
      message
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-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();
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)
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"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "paymentScheduleId": "gid://shopify/PaymentSchedule/864539144"
}
Hide code
Response
JSON
{
  "paymentReminderSend": {
    "success": true,
    "userErrors": []
  }
}