Response to web API requests: 200: OK

The successful response will contain the Paywall object.

Paywall object

The object that contains information on a paywall.

Properties

Name	Type	Required	Description
placement_id	String	➕	The ID of the Placement where this paywall is shown. This value is set when creating a placement in your Adapty Dashboard.
variation_id	String(uuid)	➕	The variation ID used to track purchases linked to this specific paywall.
paywall_id	String(uuid)	➕	The unique identifier of the paywall.
ab_test_name	String	➖	The name of the parent A/B test.
paywall_name	String	➕	The name of the paywall, as defined in your Adapty Dashboard.
products	Array of objects	➕	Array of Products objects containing product information for the paywall.
remote_config	JSON	➖	A RemoteConfig object in JSON format containing the full remote config of the paywall.

Example

JSON

{
  "placement_id": "PaywallPlacementId",
  "variation_id": "00000000-0000-0000-0000-000000000000",
  "paywall_id": "InternalPaywallId",
  "ab_test_name": "Existing Offer | Improved Offer",
  "paywall_name": "Used Paywall",
  "products": [
    {
      "title": "Monthly Subscription w/o Trial",
      "is_consumable": true,
      "adapty_product_id": "InternalProductId",
      "vendor_product_id": "onemonth_no_trial",
      "introductory_offer_eligibility": false,
      "promotional_offer_eligibility": true,
      "base_plan_id": "B1",
      "offer": {
        "category": "promotional",
        "type": "pay_up_front",
        "id": "StoreOfferId"
      }
    }
  ],
  "remote_config": {
    "lang": "en",
    "data": "RemoteConfigObject"
  }
}