Choose a version:

paymentCustomizationUpdate

mutation

Requires write_payment_customizations access scope.

Updates an existing payment customization, modifying its configuration for how payment methods are displayed at checkout. Use this to change the customization's title or enabled state. The customization's function can't be changed once set; create a new payment customization to use a different function.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The global ID of the payment customization.

Anchor to paymentCustomizationpaymentCustomization

•PaymentCustomizationInput!

required

The input data used to update the payment customization.

Was this section helpful?

Anchor to PaymentCustomizationUpdatePayload returnsPaymentCustomizationUpdatePayload returns

Anchor to paymentCustomizationpaymentCustomization •PaymentCustomization: Returns the updated payment customization.
Anchor to userErrorsuserErrors •[PaymentCustomizationError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

paymentCustomizationUpdate reference

Mutation Reference

mutation paymentCustomizationUpdate($id: ID!, $paymentCustomization: PaymentCustomizationInput!) {

paymentCustomizationUpdate(id: $id, paymentCustomization: $paymentCustomization) {

paymentCustomization {

# PaymentCustomization fields

}

userErrors {

field

message

}

Input

{

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

"paymentCustomization": {

"functionHandle": "<your-functionHandle>",

"title": "<your-title>",

"enabled": true,

"metafields": [

{

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

"namespace": "<your-namespace>",

"key": "<your-key>",

"value": "<your-value>",

"type": "<your-type>"

}

]

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "paymentCustomization": {
    "functionHandle": "<your-functionHandle>",
    "title": "<your-title>",
    "enabled": true,
    "metafields": [
      {
        "id": "gid://shopify/<objectName>/10079785100",
        "namespace": "<your-namespace>",
        "key": "<your-key>",
        "value": "<your-value>",
        "type": "<your-type>"
      }
    ]
  }
}

Schema

input PaymentCustomizationInput {
  functionHandle: String
  title: String
  enabled: Boolean
  metafields: [MetafieldInput!]
}

input MetafieldInput {
  id: ID
  namespace: String
  key: String
  value: String
  type: String
}