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.
- 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)
- 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.
- Anchor to customerIdcustomer•ID!
Id required The ID of the customer.
- Anchor to billingAddressbilling•Mailing
Address Address Input The billing address.
- Anchor to billingAgreementIdbilling•String!
Agreement Id required The billing agreement ID from PayPal that starts with 'B-' (for example,
).- 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.
- •ID!required
The ID of the customer payment method.
- Anchor to billingAddressbilling•Mailing
Address Address Input! required The billing address.
Arguments
- •ID!