---
title: PaymentSessionModalUserError - Payments Apps API
description: An error that occurs during the execution of `PaymentSessionModal`.
api_version: 2026-01
api_name: payments-apps
type: object
api_type: graphql
source_url:
  html: >-
    https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionModalUserError
  md: >-
    https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionModalUserError.md
---

# Payment​Session​Modal​User​Error

object

An error that occurs during the execution of `PaymentSessionModal`.

## Fields

* code

  [Payment​Session​Modal​User​Error​Code](https://shopify.dev/docs/api/payments-apps/latest/enums/PaymentSessionModalUserErrorCode)

  The error code.

* field

  [\[String!\]](https://shopify.dev/docs/api/payments-apps/latest/scalars/String)

  The path to the input field that caused the error.

* message

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

  non-null

  The error message.

***

## Map

No referencing types

***

## Mutations

* [payment​Session​Modal](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentSessionModal)

  mutation

  Raises a modal that will be displayed to the buyer after a checkout is completed. Included data will be used to populate the UI extension in the modal.

  * id

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

    required

    ### Arguments

    The payment session ID.

  * expires​At

    [Date​Time](https://shopify.dev/docs/api/payments-apps/latest/scalars/DateTime)

    The date and time the modal will expire, in UTC

  * action

    [Modal​Action!](https://shopify.dev/docs/api/payments-apps/latest/input-objects/ModalAction)

    required

    The buyer action and corresponding data that will be made available in the modal at runtime.

  ***

***

## PaymentSessionModalUserError Mutations

### Mutated by

* [payment​Session​Modal](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentSessionModal)

***

## Interfaces

* [Displayable​Error](https://shopify.dev/docs/api/payments-apps/latest/interfaces/DisplayableError)

  interface

***

## PaymentSessionModalUserError Implements

### Implements

* [Displayable​Error](https://shopify.dev/docs/api/payments-apps/latest/interfaces/DisplayableError)