Anchor to PaymentInstrumentSendAddEmailPayloadPayment
payloadPayment
Return type for mutation.
Anchor to FieldsFields
- customer (Customer)
- userErrors ([UserError!]!)
- Anchor to customercustomer•Customer
The customer to whom an add payment instrument email was sent.
Show fields
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Show fields
Was this section helpful?
Anchor to Mutations with this payloadMutations with this payload
- paymentInstrumentSendAddEmail (PaymentInstrumentSendAddEmailPayload)
- •mutation
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.
Show payload
- Anchor to emailemail•Email
Input Specifies the payment instrument add email fields. Only the 'from' and 'bcc' fields are accepted for input.
Show input fields
- Anchor to mandatemandate•Payment
Instrument Mandate Input! required The mandate resource (subscription, order, or draft order) to add a payment instrument for.
Show input fields
Arguments
Was this section helpful?