Choose a version:

paymentInstrumentSendAddEmail

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.

Anchor to Arguments

Arguments

Anchor to emailemail

•EmailInput

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

Show input fields

Anchor to mandatemandate

•PaymentInstrumentMandateInput!

required

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

Show input fields

Was this section helpful?

Anchor to PaymentInstrumentSendAddEmailPayload returnsPaymentInstrumentSendAddEmailPayload returns

Anchor to customercustomer •Customer: The customer to whom an add payment instrument email was sent.

Show fields
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

paymentInstrumentSendAddEmail reference

Mutation Reference

mutation paymentInstrumentSendAddEmail($email: EmailInput, $mandate: PaymentInstrumentMandateInput!) {

paymentInstrumentSendAddEmail(email: $email, mandate: $mandate) {

customer {

# Customer fields

}

userErrors {

field

message

}

Input

{

"email": {

"bcc": [

"<your-bcc>"

"body": "<your-body>",

"customMessage": "<your-customMessage>",

"from": "<your-from>",

"subject": "<your-subject>",

"to": "<your-to>"

"mandate": {

"resourceId": "<your-resourceId>",

"resourceType": "DRAFT_ORDERS"

}

Variables

{
  "email": {
    "bcc": [
      "<your-bcc>"
    ],
    "body": "<your-body>",
    "customMessage": "<your-customMessage>",
    "from": "<your-from>",
    "subject": "<your-subject>",
    "to": "<your-to>"
  },
  "mandate": {
    "resourceId": "<your-resourceId>",
    "resourceType": "DRAFT_ORDERS"
  }
}

Schema

input EmailInput {
  bcc: [String!]
  body: String
  customMessage: String
  from: String
  subject: String
  to: String
}

input PaymentInstrumentMandateInput {
  resourceId: String!
  resourceType: PaymentInstrumentMandateResourceType!
}