Anchor to section titled 'undefined'

paymentCustomizationUpdate
mutation

Requires write_payment_customizations access scope.

Updates a payment customization.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

The global ID of the payment customization.

Anchor to paymentCustomization
paymentCustomization
PaymentCustomizationInput!
required

The input data used to update the payment customization.

Was this section helpful?
Anchor to section titled 'PaymentCustomizationUpdatePayload returns'

PaymentCustomizationUpdatePayload returns

Anchor to PaymentCustomizationUpdatePayload.paymentCustomization
paymentCustomization
PaymentCustomization

Returns the updated payment customization.

Anchor to PaymentCustomizationUpdatePayload.userErrors
userErrors
[PaymentCustomizationError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation paymentCustomizationUpdate($id: ID!, $paymentCustomization: PaymentCustomizationInput!) {
  paymentCustomizationUpdate(id: $id, paymentCustomization: $paymentCustomization) {
    paymentCustomization {
      # PaymentCustomization fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "id": "gid://shopify/<objectName>/10079785100",
  "paymentCustomization": {
    "enabled": true,
    "functionId": "<your-functionId>",
    "metafields": [
      {
        "description": "<your-description>",
        "id": "gid://shopify/<objectName>/10079785100",
        "key": "<your-key>",
        "namespace": "<your-namespace>",
        "type": "<your-type>",
        "value": "<your-value>"
      }
    ],
    "title": "<your-title>"
  }
}
input PaymentCustomizationInput {
  enabled: Boolean
  functionId: String
  metafields: [MetafieldInput!]
  title: String
}

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