---
title: paymentSessionModal - Payments Apps API
description: >-
  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.
api_version: 2026-10
source_url:
  html: >-
    https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentSessionModal
  md: >-
    https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentSessionModal.md
api_name: payments-apps
api_type: graphql
type: mutation
---

# payment​Session​Modal

mutation

Requires `write_payment_sessions` access scope.

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.

## Arguments

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

* expires​At

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

  The date and time the modal will expire, in UTC

* id

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

  required

  The payment session ID.

***

## Payment​Session​Modal​Payload returns

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

***

## Examples

* ### paymentSessionModal reference