Customer
Requires access scope. Also: Requires scope.
An error in the input of a mutation. Mutations return objects to
indicate validation failures, such as invalid field values or business logic
violations, that prevent the operation from completing.
Anchor to FieldsFields
- code (CustomerPaymentMethodUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Customer
Payment Method User Error Code The error code.
Show enum values
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- customerPaymentMethodPaypalBillingAgreementCreate (CustomerPaymentMethodPaypalBillingAgreementCreatePayload)
- customerPaymentMethodPaypalBillingAgreementUpdate (CustomerPaymentMethodPaypalBillingAgreementUpdatePayload)
- customerPaymentMethodRemoteBillingAddressUpdate (CustomerPaymentMethodRemoteBillingAddressUpdatePayload)
- Anchor to customerPaymentMethodPaypalBillingAgreementCreatecustomer•mutation
Payment Method Paypal Billing Agreement Create Creates a vaulted PayPal billing agreement for a customer, enabling recurring charges through PayPal. The billing agreement ID (starting with 'B-') must be obtained from PayPal. Once created, this payment method can be used for subscription billing or future order payments without requiring the customer to re-authenticate with PayPal.
Show payload
- Anchor to billingAddressbilling•Mailing
Address Address Input The billing address.
Show input fields
- Anchor to billingAgreementIdbilling•String!
Agreement Id required The billing agreement ID from PayPal that starts with 'B-' (for example,
).- Anchor to customerIdcustomer•ID!
Id required The ID of the customer.
- Anchor to inactiveinactive•BooleanDefault:false
Whether the PayPal billing agreement is inactive.
Arguments
- Anchor to customerPaymentMethodPaypalBillingAgreementUpdatecustomer•mutation
Payment Method Paypal Billing Agreement Update Updates the billing address associated with a customer's vaulted PayPal billing agreement. Use this when a customer's billing information has changed and their PayPal payment method record in Shopify needs to be updated accordingly.
Show payload
- Anchor to billingAddressbilling•Mailing
Address Address Input! required The billing address.
Show input fields
- •ID!required
The ID of the customer payment method.
Arguments
- Anchor to customerPaymentMethodRemoteBillingAddressUpdatecustomer•mutation
Payment Method Remote Billing Address Update Updates the billing address on a customer's remote credit card or PayPal billing agreement imported with
. Use this when the billing address is incomplete or incorrect and needs to be corrected in Shopify without re-importing the payment method. The payment method is not re-verified and the buyer is not charged.The address is saved in Shopify only. It is not sent to the payment gateway, so the address the gateway holds is unchanged.
Show payload
- Anchor to billingAddressbilling•Mailing
Address Address Input! required The billing address.
Show input fields
- •ID!required
The ID of the customer payment method.
Arguments