Anchor to section titled 'undefined'

customerPaymentMethodPaypalBillingAgreementUpdate
mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Updates a PayPal billing agreement for a customer.

Anchor to section titled 'Arguments'

Arguments

Anchor to billingAddress
billingAddress
MailingAddressInput!
required

The billing address.

Anchor to id
id
ID!
required

The ID of the customer payment method.

Was this section helpful?
Anchor to section titled 'CustomerPaymentMethodPaypalBillingAgreementUpdatePayload returns'

CustomerPaymentMethodPaypalBillingAgreementUpdatePayload returns

Anchor to CustomerPaymentMethodPaypalBillingAgreementUpdatePayload.customerPaymentMethod
customerPaymentMethod
CustomerPaymentMethod

The customer payment method.

Anchor to CustomerPaymentMethodPaypalBillingAgreementUpdatePayload.userErrors
userErrors
[CustomerPaymentMethodUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerPaymentMethodPaypalBillingAgreementUpdate($billingAddress: MailingAddressInput!, $id: ID!) {
  customerPaymentMethodPaypalBillingAgreementUpdate(billingAddress: $billingAddress, id: $id) {
    customerPaymentMethod {
      # CustomerPaymentMethod fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "billingAddress": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "countryCode": "AC",
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "phone": "<your-phone>",
    "provinceCode": "<your-provinceCode>",
    "zip": "<your-zip>"
  },
  "id": "gid://shopify/<objectName>/10079785100"
}
input MailingAddressInput {
  address1: String
  address2: String
  city: String
  company: String
  country: String
  countryCode: CountryCode
  firstName: String
  id: ID
  lastName: String
  phone: String
  province: String
  provinceCode: String
  zip: String
}