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

Obtener paywall

Recupera un paywall específico de tu app.

Path parameters

paywall_idstring · uuidrequired

El identificador único del paywall a recuperar

Responses

Paywall recuperado correctamente

Schema
titlestringrequired

El nombre del paywall, tal como está definido en tu Adapty Dashboard

paywall_idstringrequired

El identificador único del paywall

use_paywall_builderbooleanrequired

Si el paywall utiliza el Paywall Builder

use_paywall_builder_legacybooleanrequired

Si el paywall utiliza el Paywall Builder heredado

updated_atstringrequired

Marca de tiempo de la última actualización del paywall

created_atstringrequired

Marca de tiempo de la creación del paywall

statestringrequired

El estado actual del paywall

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

is_deletedbooleanrequired

Si el paywall está marcado como eliminado

web_purchase_urlstring

URL para compras web, si corresponde

productsarray of objectrequired

Array de objetos de producto con información sobre los productos

product_idstringrequired

El identificador único del producto

titlestringrequired

El título del producto

product_setstringrequired

La categoría del conjunto de productos

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

offerobjectrequired
product_offer_idstringrequired

El identificador único de la oferta de producto

titlestringrequired

El título de la oferta

remote_configsarray of object

Array de objetos RemoteConfig con la configuración regional y los datos

localestringrequired

La configuración regional del Remote Config

datastringrequired

Cadena JSON que contiene los datos del Remote Config

main_screenshotobject

Objeto de captura de pantalla principal con image_id y url

image_idintegerrequired

El identificador único de la imagen

urlstringrequired

La URL de la imagen

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"
  }
}

No autorizado

Schema
errorsarray of objectrequired
sourcestring

Origen del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

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

Paywall no encontrado

Schema
errorsarray of objectrequired
sourcestring

Origen del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

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

Error interno del servidor

Schema
errorsarray of objectrequired
sourcestring

Origen del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP