--- title: PaymentCustomization - GraphQL Admin description: A payment customization. api_version: 2025-01 api_name: admin type: object api_type: graphql source_url: html: >- https://shopify.dev/docs/api/admin-graphql/2025-01/objects/PaymentCustomization md: >- https://shopify.dev/docs/api/admin-graphql/2025-01/objects/PaymentCustomization.md --- # Payment​Customization object Requires `read_payment_customizations` access scope. A payment customization. ## Fields * enabled [Boolean!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) non-null The enabled status of the payment customization. * error​History [Functions​Error​History](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/FunctionsErrorHistory) The error history on the most recent version of the payment customization. * function​Id [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-null The ID of the Shopify Function implementing the payment customization. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * namespace [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) ### Arguments The container the metafield belongs to. If omitted, the app-reserved namespace will be used. * key [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) required The key for the metafield. *** * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * namespace [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) ### Arguments The metafield namespace to filter by. If omitted, the app-reserved namespace will be used. * keys [\[String!\]](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) List of keys of metafields in the format `namespace.key`, will be returned in the same format. * first [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * after [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) Default:false Reverse the order of the underlying list. *** * shopify​Function [Shopify​Function!](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/ShopifyFunction) non-null The Shopify Function implementing the payment customization. * title [String!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) non-null The title of the payment customization. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/MetafieldDefinitionConnection) non-nullDeprecated * namespace [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) ### Arguments Filter metafield definitions by namespace. * pinned​Status [Metafield​Definition​Pinned​Status](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/MetafieldDefinitionPinnedStatus) Default:ANY Filter by the definition's pinned status. * first [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * after [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) Default:false Reverse the order of the underlying list. * sort​Key [Metafield​Definition​Sort​Keys](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/MetafieldDefinitionSortKeys) 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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). * query [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/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](https://shopify.dev/api/usage/search-syntax). * * default string * created\_at time * id id * key string * namespace string * owner\_type string * type string * updated\_at time - Filter by a case-insensitive search of multiple fields in a document. - Example: * `query=Bob Norman` * `query=title:green hoodie` Filter by the date and time when the metafield definition was created. - Example: * `created_at:>2020-10-21T23:39:20Z` * `created_at:=1234` * `id:<=1234` Filter by the metafield definition [`key`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-key) field. - Example: * `key:some-key` Filter by the metafield definition [`namespace`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-namespace) field. - Example: * `namespace:some-namespace` Filter by the metafield definition [`ownerType`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-ownertype) field. - Example: * `owner_type:PRODUCT` Filter by the metafield definition [`type`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-type) field. - Example: * `type:single_line_text_field` Filter by the date and time when the metafield definition was last updated. Example: * `updated_at:>2020-10-21T23:39:20Z` * `updated_at:[PaymentCustomizationConnection.nodes](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/PaymentCustomizationConnection#returns-nodes) * {}[PaymentCustomizationEdge.node](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/PaymentCustomizationEdge#field-PaymentCustomizationEdge.fields.node) ### Possible type in * [Metafield​Referencer](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/MetafieldReferencer) *** ## Queries * [payment​Customization](https://shopify.dev/docs/api/admin-graphql/2025-01/queries/paymentCustomization) query The payment customization. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) required ### Arguments The ID of the payment customization. *** * [payment​Customizations](https://shopify.dev/docs/api/admin-graphql/2025-01/queries/paymentCustomizations) query The payment customizations. * first [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) ### Arguments The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * after [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/Boolean) Default:false Reverse the order of the underlying list. * query [String](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/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](https://shopify.dev/api/usage/search-syntax). * enabled boolean * function\_id string * id id Filter by `id` range. Example: * `id:1234` * `id:>=1234` * `id:<=1234` *** *** ## \PaymentCustomization Queries ### Queried by * \[payment​Customization](https://shopify.dev/docs/api/admin-graphql/2025-01/queries/paymentCustomization) * \[payment​Customizations](https://shopify.dev/docs/api/admin-graphql/2025-01/queries/paymentCustomizations) *** ## Mutations * [payment​Customization​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/paymentCustomizationCreate) mutation Creates a payment customization. * payment​Customization [Payment​Customization​Input!](https://shopify.dev/docs/api/admin-graphql/2025-01/input-objects/PaymentCustomizationInput) required ### Arguments The input data used to create the payment customization. *** * [payment​Customization​Update](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/paymentCustomizationUpdate) mutation Updates a payment customization. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) required ### Arguments The global ID of the payment customization. * payment​Customization [Payment​Customization​Input!](https://shopify.dev/docs/api/admin-graphql/2025-01/input-objects/PaymentCustomizationInput) required The input data used to update the payment customization. *** *** ## <\~> PaymentCustomization Mutations ### Mutated by * <\~>[payment​Customization​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/paymentCustomizationCreate) * <\~>[payment​Customization​Update](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/paymentCustomizationUpdate) *** ## Interfaces * * [Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/HasMetafieldDefinitions) interface * [Has​Metafields](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/HasMetafields) interface * [Node](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/Node) interface *** ## ||-PaymentCustomization Implements ### Implements * ||-[Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/HasMetafieldDefinitions) * ||-[Has​Metafields](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/HasMetafields) * ||-[Node](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/Node)