---
title: paymentInstrumentSendAddEmail - GraphQL Admin
description: |-
  Sends an email to a customer containing a secure link to add a new payment
  instrument (e.g., credit card) for a specific resource such as a subscription,
  order, or draft order. This is used when a customer needs to provide payment
  details for an existing resource — for example, after a payment method was
  revoked or when setting up payment for a new subscription contract.
api_version: 2026-10
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentInstrumentSendAddEmail
  md: >-
    https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentInstrumentSendAddEmail.md
api_name: admin
api_type: graphql
type: mutation
---

# payment​Instrument​Send​Add​Email

mutation

Requires `write_customers` access scope. Also: The user must have permission to create and edit customers, and read access to the mandate resource.

Sends an email to a customer containing a secure link to add a new payment instrument (e.g., credit card) for a specific resource such as a subscription, order, or draft order. This is used when a customer needs to provide payment details for an existing resource — for example, after a payment method was revoked or when setting up payment for a new subscription contract.

## Arguments

* email

  [Email​Input](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/EmailInput)

  Specifies the payment instrument add email fields. Only the 'from' and 'bcc' fields are accepted for input.

* mandate

  [Payment​Instrument​Mandate​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/PaymentInstrumentMandateInput)

  required

  The mandate resource (subscription, order, or draft order) to add a payment instrument for.

***

## Payment​Instrument​Send​Add​Email​Payload returns

* customer

  [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer)

  The customer to whom an add payment instrument email was sent.

* user​Errors

  [\[User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/UserError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Examples

* ### paymentInstrumentSendAddEmail reference