customerPaymentMethodRemoteBillingAddressUpdate

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Updates the billing address on a customer's remote credit card or PayPal billing agreement imported with customerPaymentMethodRemoteCreate. 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.

Anchor to Arguments

Arguments

Anchor to billingAddressbillingAddress

•MailingAddressInput!

required

The billing address.

Show input fields

Anchor to idid

•ID!

required

The ID of the customer payment method.

Was this section helpful?

Anchor to CustomerPaymentMethodRemoteBillingAddressUpdatePayload returnsCustomerPaymentMethodRemoteBillingAddressUpdatePayload returns

Anchor to customerPaymentMethodcustomerPaymentMethod •CustomerPaymentMethod: The customer payment method.

Show fields
Anchor to userErrorsuserErrors •[CustomerPaymentMethodUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

customerPaymentMethodRemoteBillingAddressUpdate reference

Mutation Reference

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

customerPaymentMethodRemoteBillingAddressUpdate(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": "AC",

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

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

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

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

"zip": "<your-zip>"

"id": "gid://shopify/CustomerPaymentMethod/10079785100"

}

Variables

{
  "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/CustomerPaymentMethod/10079785100"
}

Schema

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