---
title: ApiVersion - Payments Apps API
description: |-
  A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).
  Versions are commonly referred to by their handle (for example, `2021-10`).
api_version: 2026-04
source_url:
  html: https://shopify.dev/docs/api/payments-apps/latest/objects/apiversion
  md: https://shopify.dev/docs/api/payments-apps/latest/objects/apiversion.md
---

# Api​Version

object

A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). Versions are commonly referred to by their handle (for example, `2021-10`).

## Fields

* display​Name

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

  non-null

  The human-readable name of the version.

* handle

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

  non-null

  The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.

* supported

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

  non-null

  Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning).

***

## Map

No referencing types

***

## Queries

* [public​Api​Versions](https://shopify.dev/docs/api/payments-apps/latest/queries/publicApiVersions)

  query

  The list of public Payments Apps API versions, including supported, release candidate and unstable versions.

***

## ApiVersion Queries

### Queried by

* [public​Api​Versions](https://shopify.dev/docs/api/payments-apps/latest/queries/publicApiVersions)