---
title: PaymentCustomization - GraphQL Admin
description: A payment customization.
api_version: 2025-10
api_name: admin
type: object
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentCustomization
  md: https://shopify.dev/docs/api/admin-graphql/latest/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/latest/scalars/Boolean)

  non-null

  The enabled status of the payment customization.

* error​History

  [Functions​Error​History](https://shopify.dev/docs/api/admin-graphql/latest/objects/FunctionsErrorHistory)

  The error history on the most recent version of the payment customization.

* function​Id

  [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  non-null

  The ID of the Shopify Function implementing the payment customization.

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)

  non-null

  A globally-unique ID.

* metafield

  [Metafield](https://shopify.dev/docs/api/admin-graphql/latest/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.

* metafields

  [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/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.

* shopify​Function

  [Shopify​Function!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyFunction)

  non-null

  The Shopify Function implementing the payment customization.

* title

  [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)

  non-null

  The title of the payment customization.

* metafield​Definitions

  [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection)

  non-nullDeprecated

***

## Map

### Fields and connections with this object

* <->[PaymentCustomizationConnection.nodes](https://shopify.dev/docs/api/admin-graphql/latest/connections/PaymentCustomizationConnection#returns-nodes)
* {}[PaymentCustomizationEdge.node](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentCustomizationEdge#field-PaymentCustomizationEdge.fields.node)

### Possible type in

* [Metafield​Referencer](https://shopify.dev/docs/api/admin-graphql/latest/unions/MetafieldReferencer)

***

## Queries

* [payment​Customization](https://shopify.dev/docs/api/admin-graphql/latest/queries/paymentCustomization)

  query

  The payment customization.

* [payment​Customizations](https://shopify.dev/docs/api/admin-graphql/latest/queries/paymentCustomizations)

  query

  The payment customizations.

***

## \<?>PaymentCustomization Queries

### Queried by

* \<?>[payment​Customization](https://shopify.dev/docs/api/admin-graphql/latest/queries/paymentCustomization)
* \<?>[payment​Customizations](https://shopify.dev/docs/api/admin-graphql/latest/queries/paymentCustomizations)

***

## Mutations

* [payment​Customization​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentCustomizationCreate)

  mutation

  Creates a payment customization.

* [payment​Customization​Update](https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentCustomizationUpdate)

  mutation

  Updates a payment customization.

***

## <\~> PaymentCustomization Mutations

### Mutated by

* <\~>[payment​Customization​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentCustomizationCreate)
* <\~>[payment​Customization​Update](https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentCustomizationUpdate)

***

## Interfaces

* * [Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafieldDefinitions)

    interface

  * [Has​Metafields](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafields)

    interface

  * [Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)

    interface

***

## ||-PaymentCustomization Implements

### Implements

* ||-[Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafieldDefinitions)
* ||-[Has​Metafields](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasMetafields)
* ||-[Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)