customerPaymentMethodCreditCardUpdate

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Updates an existing vaulted credit card payment method for a customer, including billing address and card details. Requires a valid cardserver session from a PCI-compliant environment. Use this when a customer's card details have changed (e.g., new expiration date or replacement card) and ongoing subscriptions or saved payment methods need to be updated.

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.

Anchor to sessionIdsessionId

•String!

required

The Cardserver session ID.

Was this section helpful?

Anchor to CustomerPaymentMethodCreditCardUpdatePayload returnsCustomerPaymentMethodCreditCardUpdatePayload returns

Anchor to customerPaymentMethodcustomerPaymentMethod •CustomerPaymentMethod: The customer payment method.

Show fields
Anchor to processingprocessing •Boolean: If the card verification result is processing. When this is true, customer_payment_method will be null.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

customerPaymentMethodCreditCardUpdate reference

Mutation Reference

mutation customerPaymentMethodCreditCardUpdate($billingAddress: MailingAddressInput!, $id: ID!, $sessionId: String!) {

customerPaymentMethodCreditCardUpdate(billingAddress: $billingAddress, id: $id, sessionId: $sessionId) {

customerPaymentMethod {

# CustomerPaymentMethod fields

}

processing

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",

"sessionId": "<your-sessionId>"

}

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",
  "sessionId": "<your-sessionId>"
}

Schema

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