paymentCustomizationActivation

mutation

Requires write_payment_customizations access scope.

Activates or deactivates payment customizations for the shop. Payment customizations allow apps to hide, reorder, or rename payment methods at checkout based on cart contents, customer attributes, or other conditions. Use this to toggle customizations on or off without deleting them.

Anchor to Arguments

Arguments

Anchor to enabledenabled •Boolean! required: The enabled status of the payment customizations.
Anchor to idsids •[ID!]! required: The global IDs of the payment customizations.

Was this section helpful?

Anchor to PaymentCustomizationActivationPayload returnsPaymentCustomizationActivationPayload returns

Anchor to idsids •[String!]: The IDs of the updated payment customizations.
Anchor to userErrorsuserErrors •[PaymentCustomizationError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

paymentCustomizationActivation reference

Mutation Reference

mutation paymentCustomizationActivation($ids: [ID!]!, $enabled: Boolean!) {

paymentCustomizationActivation(ids: $ids, enabled: $enabled) {

ids

userErrors {

field

message

}

Input

{

"ids": [

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

"enabled": true

}