Payment
Requires access scope.
An error that occurs during the execution of a payment customization mutation.
Anchor to FieldsFields
- code (PaymentCustomizationErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Payment
Customization Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- paymentCustomizationActivation (PaymentCustomizationActivationPayload)
- paymentCustomizationCreate (PaymentCustomizationCreatePayload)
- paymentCustomizationDelete (PaymentCustomizationDeletePayload)
- paymentCustomizationUpdate (PaymentCustomizationUpdatePayload)
- •mutation
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.
- •[ID!]!required
The global IDs of the payment customizations.
- Anchor to enabledenabled•Boolean!required
The enabled status of the payment customizations.
Arguments
- •[ID!]!
- •mutation
Creates a new payment customization for the shop. Payment customizations let apps modify the payment methods shown at checkout — hiding, reordering, or renaming options based on cart contents, customer attributes, or other business logic.
- Anchor to paymentCustomizationpayment•Payment
Customization Customization Input! required The input data used to create the payment customization.
Arguments
- •mutation
Permanently deletes a payment customization. Once deleted, the customization will no longer affect which payment methods appear at checkout.
- •ID!required
The global ID of the payment customization.
Arguments
- •ID!
- •mutation
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.
- •ID!required
The global ID of the payment customization.
- Anchor to paymentCustomizationpayment•Payment
Customization Customization Input! required The input data used to update the payment customization.
Arguments
- •ID!