Choose a version:

customerPaymentMethodPaypalBillingAgreementUpdate

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Updates a PayPal billing agreement for a customer.

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?

Mutation Reference

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

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

customerPaymentMethod {

# CustomerPaymentMethod fields

}

userErrors {

field

message

}

Input

{

"billingAddress": {

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

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

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

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

"countryCode": "",

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

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

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

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

"zip": "<your-zip>"

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

}

{
  "billingAddress": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "countryCode": "",
    "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
}