customerPaymentMethodPaypalBillingAgreementUpdate

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

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.

Anchor to Arguments

Arguments

Anchor to billingAddressbillingAddress

•MailingAddressInput!

required

The billing address.

Anchor to idid

•ID!

required

The ID of the customer payment method.

Was this section helpful?

Anchor to CustomerPaymentMethodPaypalBillingAgreementUpdatePayload returnsCustomerPaymentMethodPaypalBillingAgreementUpdatePayload returns

Anchor to customerPaymentMethodcustomerPaymentMethod •CustomerPaymentMethod: The customer payment method.
Anchor to userErrorsuserErrors •[CustomerPaymentMethodUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

customerPaymentMethodPaypalBillingAgreementUpdate reference

Mutation Reference

mutation customerPaymentMethodPaypalBillingAgreementUpdate($id: ID!, $billingAddress: MailingAddressInput!) {

customerPaymentMethodPaypalBillingAgreementUpdate(id: $id, billingAddress: $billingAddress) {

customerPaymentMethod {

# CustomerPaymentMethod fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"billingAddress": {

"address1": "<your-address1>",

"address2": "<your-address2>",

"city": "<your-city>",

"company": "<your-company>",

"countryCode": "AF",

"firstName": "<your-firstName>",

"lastName": "<your-lastName>",

"phone": "<your-phone>",

"provinceCode": "<your-provinceCode>",

"zip": "<your-zip>"

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "billingAddress": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "countryCode": "AF",
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "phone": "<your-phone>",
    "provinceCode": "<your-provinceCode>",
    "zip": "<your-zip>"
  }
}

Schema

input MailingAddressInput {
  address1: String
  address2: String
  city: String
  company: String
  countryCode: CountryCode
  firstName: String
  lastName: String
  phone: String
  provinceCode: String
  zip: String
}