---
title: PaymentSessionModalPayload - Payments Apps API
description: Return type for `paymentSessionModal` mutation.
api_version: 2026-04
source_url:
  html: >-
    https://shopify.dev/docs/api/payments-apps/latest/payloads/PaymentSessionModalPayload
  md: >-
    https://shopify.dev/docs/api/payments-apps/latest/payloads/PaymentSessionModalPayload.md
api_name: payments-apps
api_type: graphql
type: payload
---

# Payment​Session​Modal​Payload

payload

Return type for `paymentSessionModal` mutation.

## Fields

* payment​Session

  [Payment​Session](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSession)

  The updated payment session.

* user​Errors

  [\[Payment​Session​Modal​User​Error!\]!](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentSessionModalUserError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Mutations with this payload

* [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.

  ***

***

## Map

### Mutations with this payload

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