GET /api/v2/server-side-api/paywalls/{paywall_id}/

Получить пейвол

Copy as Markdown

Возвращает данные конкретного пейвола в вашем приложении.

Path parameters

paywall_idstring · uuidrequired

Уникальный идентификатор получаемого пейвола

Responses

Пейвол успешно получен

Schema
titlestringrequired

Название пейвола, заданное в дашборде Adapty

paywall_idstringrequired

Уникальный идентификатор пейвола

use_paywall_builderbooleanrequired

Использует ли пейвол Paywall Builder

use_paywall_builder_legacybooleanrequired

Использует ли пейвол устаревший Paywall Builder

updated_atstringrequired

Временная метка последнего обновления пейвола

created_atstringrequired

Временная метка создания пейвола

statestringrequired

Текущий статус пейвола

One of: "draft", "live", "inactive", "archived"

is_deletedbooleanrequired

Помечен ли пейвол как удалённый

web_purchase_urlstring

URL для веб-покупок, если применимо

productsarray of objectrequired

Массив объектов продуктов с информацией о продуктах

product_idstringrequired

Уникальный идентификатор продукта

titlestringrequired

Название продукта

product_setstringrequired

Категория набора продуктов

One of: "weekly", "monthly", "trimonthly", "semiannual", "annual", "lifetime", "uncategorised", "nonsubscriptions", "two_months", "consumable"

offerobjectrequired
product_offer_idstringrequired

Уникальный идентификатор офера продукта

titlestringrequired

Название офера

remote_configsarray of object

Массив объектов RemoteConfig с локалью и данными

localestringrequired

Локаль для Remote Config

datastringrequired

JSON-строка, содержащая данные Remote Config

main_screenshotobject

Объект основного скриншота с image_id и url

image_idintegerrequired

Уникальный идентификатор изображения

urlstringrequired

URL изображения

Example 
{
  "title": "Premium Subscription",
  "paywall_id": "fd891d4f-5906-45b9-97c1-13cc3dc665df",
  "use_paywall_builder": true,
  "use_paywall_builder_legacy": false,
  "updated_at": "2025-07-30T11:13:58.798Z",
  "created_at": "2025-07-30T11:13:58.798Z",
  "state": "live",
  "is_deleted": false,
  "web_purchase_url": "https://example.com/purchase",
  "products": [
    {
      "product_id": "b95e9e51-a056-4eb6-9cf7-b75d139e7c3c",
      "title": "Premium Monthly",
      "product_set": "uncategorised",
      "offer": {
        "product_offer_id": "e31a4296-f250-4faf-ac80-3cc93c2da8f5",
        "title": "Free Trial"
      }
    }
  ],
  "remote_configs": [
    {
      "locale": "en",
      "data": "{\"title\":\"Premium Features\",\"subtitle\":\"Unlock all premium content\"}"
    }
  ],
  "main_screenshot": {
    "image_id": 123456,
    "url": "https://public-media.adapty.io/public/screenshot.jpg"
  }
}

Не авторизован

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Example 
{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

Пейвол не найден

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Example 
{
  "errors": [
    {
      "source": null,
      "errors": [
        "Paywall not found"
      ]
    }
  ],
  "error_code": "paywall_does_not_exist",
  "status_code": 404
}

Внутренняя ошибка сервера

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса