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

付费墙是否使用付费墙编辑工具

use_paywall_builder_legacybooleanrequired

付费墙是否使用旧版付费墙编辑工具

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

远程配置的语言区域

datastringrequired

包含远程配置数据的 JSON 字符串

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 状态码