customerPaymentMethodGetUpdateUrl

mutation

Requires write_customers access scope.

Returns a URL that allows the customer to update a specific payment method.

Currently, customerPaymentMethodGetUpdateUrl only supports Shop Pay.

Arguments

Anchor to customerPaymentMethodIdcustomerPaymentMethodId • ID!required: The payment method to be updated.

Was this section helpful?

Anchor to CustomerPaymentMethodGetUpdateUrlPayload returnsCustomerPaymentMethodGetUpdateUrlPayload returns

Anchor to updatePaymentMethodUrlupdatePaymentMethodUrl • URL: The URL to redirect the customer to update the payment method.
Anchor to userErrorsuserErrors • [CustomerPaymentMethodGetUpdateUrlUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation customerPaymentMethodGetUpdateUrl($customerPaymentMethodId: ID!) {
2  customerPaymentMethodGetUpdateUrl(customerPaymentMethodId: $customerPaymentMethodId) {
3    updatePaymentMethodUrl
4    userErrors {
5      field
6      message
7    }
8  }
9}

Input

1{
2  "customerPaymentMethodId": "gid://shopify/<objectName>/10079785100"
3}

{
  "customerPaymentMethodId": "gid://shopify/<objectName>/10079785100"
}