API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

customerPaymentMethodSendUpdateEmail mutation

Version unstable

Sends a link to the customer so they can update a specific payment method.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customerPaymentMethodId ( ID! ) required

The payment method to be updated.

email ( EmailInput )

Specifies the payment method update email fields.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • customer (Customer)

    The customer to whom an update payment method email was sent.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-07 (Release candidate)

Sends a link to the customer so they can update a specific payment method.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customerPaymentMethodId ( ID! ) required

The payment method to be updated.

email ( EmailInput )

Specifies the payment method update email fields.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • customer (Customer)

    The customer to whom an update payment method email was sent.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Latest)

Sends a link to the customer so they can update a specific payment method.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customerPaymentMethodId ( ID! ) required

The payment method to be updated.

email ( EmailInput )

Specifies the payment method update email fields.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • customer (Customer)

    The customer to whom an update payment method email was sent.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01

Sends a link to the customer so they can update a specific payment method.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
customerPaymentMethodId ( ID! ) required

The payment method to be updated.

email ( EmailInput )

Specifies the payment method update email fields.

EmailInput fields

  • bcc ([String!])

    Specifies any bcc recipients for the email.

  • body (String)

    Specifies the email body.

  • customMessage (String)

    Specifies a custom message to include in the email.

  • from (String)

    Specifies the email sender.

  • subject (String)

    Specifies the email subject.

  • to (String)

    Specifies the email recipient.

Return fields

  • customer (Customer)

    The customer to whom an update payment method email was sent.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.