Payment
Requires access scope.
A payment customization.
Anchor to FieldsFields
- enabled (Boolean!)
- errorHistory (FunctionsErrorHistory)
- functionId (String!)
- id (ID!)
- metafield (Metafield)
- metafields (MetafieldConnection!)
- shopifyFunction (ShopifyFunction!)
- title (String!)
- metafieldDefinitions (MetafieldDefinitionConnection!): deprecated
- Anchor to enabledenabled•Boolean!non-null
The enabled status of the payment customization.
- Anchor to errorHistoryerror•Functions
History Error History The error history on the most recent version of the payment customization.
- Anchor to functionIdfunction•String!
Id non-null The ID of the Shopify Function implementing the payment customization.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
- •String!required
The key for the metafield.
Arguments
- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namespacenamespace•String
The metafield namespace to filter by. If omitted, all metafields are returned.
- Anchor to keyskeys•[String!]
List of keys of metafields in the format
namespace.key, will be returned in the same format.- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to shopifyFunctionshopify•Shopify
Function Function! non-null The Shopify Function implementing the payment customization.
- Anchor to titletitle•String!non-null
The title of the payment customization.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated - Anchor to namespacenamespace•String
Filter metafield definitions by namespace.
- Anchor to pinnedStatuspinned•Metafield
Status Definition Pinned Status Default:ANY Filter by the definition's pinned status.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Metafield
Key Definition Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to created_at•time
Filter by the date and time when the metafield definition was created.
created_at:>2020-10-21T23:39:20Zcreated_at:<nowcreated_at:<=2024- Anchor to namespace•string
Filter by the metafield definition
namespacefield.namespace:some-namespace- Anchor to type•string
Filter by the metafield definition
typefield.type:single_line_text_field- Anchor to updated_at•time
Filter by the date and time when the metafield definition was last updated.
updated_at:>2020-10-21T23:39:20Zupdated_at:<nowupdated_at:<=2024
Example:
Example:
Example:
Example:
Example:
Arguments
Anchor to QueriesQueries
- paymentCustomization (PaymentCustomization)
- paymentCustomizations (PaymentCustomizationConnection!)
- •query
The payment customization.
- •ID!required
The ID of the payment customization.
Arguments
- •ID!
- •query
The payment customizations.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments
Anchor to MutationsMutations
- paymentCustomizationCreate (PaymentCustomizationCreatePayload)
- paymentCustomizationUpdate (PaymentCustomizationUpdatePayload)
- •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
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!
Anchor to InterfacesInterfaces
- HasMetafieldDefinitions
- HasMetafields
- Node
- •interface
- •interface