Get paywall API request

Receives the paywall from the provided placement.

Method and endpoint

POST https://api.adapty.io/api/v2/web-api/paywall/

cURL

curl --location 'https://api.adapty.io/api/v2/web-api/paywall/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Api-Key <YOUR_PUBLIC_API_KEY>' \
--data '{
 "store": "app_store",
 "locale": "en",
 "placement_id": "PaywallPlacementId",
 "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
}'

JavaScript

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Api-Key <YOUR_PUBLIC_API_KEY>");

const raw = JSON.stringify({
  "store": "app_store",
  "locale": "en",
  "placement_id": "PaywallPlacementId",
  "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://api.adapty.io/api/v2/web-api/paywall/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.adapty.io/api/v2/web-api/paywall/")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Api-Key <YOUR_PUBLIC_API_KEY>"
request.body = JSON.dump({
  "store": "app_store",
  "locale": "en",
  "placement_id": "PaywallPlacementId",
  "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
})

response = https.request(request)
puts response.read_body

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.adapty.io/api/v2/web-api/paywall/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "store": "app_store",
  "locale": "en",
  "placement_id": "PaywallPlacementId",
  "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Api-Key <YOUR_PUBLIC_API_KEY>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Parameters

Name	Type	Required	Description
title	String	➕
use_paywall_builder	Boolean	➕
use_paywall_builder_v4	Boolean	➖	`false is used by default
remote_config_legacy	String	➖
screenshot_id	Integer	➖
builder_screenshot_id	Integer	➖
products	Array of objects	➕	Array of the Product objects containing information about products that can be sold in the paywall.
remote_configs	Array of objects	➖	Array of the RemoteConfig objects containing information about remote configs of the paywall.
paywall_builder	Object	➖
paywall_builder_v3	Object	➖

---

Responses

200: OK

The successful response will contain the 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"
  }
}

400: Bad Request

The response means that either your request is not a valid JSON or some field is missing. Correct the JSON to make it valid and add the missing parameter.

Body

Parameter	Type	Description
errors	Object	source: (string) For invalid JSON, it will be null. errors: A description of the error.
error_code	String	Short error name. Here: parse_error.
status_code	Integer	HTTP status. Always 400.

Response example

{
    "errors": [
        {
            "source": null,
            "errors": [
                "JSON parse error - Expecting ',' delimiter: line 4 column 3 (char 67)"
            ]
        }
    ],
    "error_code": "parse_error",
    "status_code": 400
}

401: Unauthorised

The request failed due to missing or incorrect authorization. Check the Authorization page, paying close attention to the Authorization header.

The request also failed because the specified profile wasn’t found.

Body

Parameter	Type	Description
errors	Object	source: (string) Always non_field_errors. errors: A description of the error.
error_code	String	Short error name. Always not_authenticated.
status_code	Integer	HTTP status. Always 401.

Response example

{
  "errors": [
    {
      "source": "non_field_errors",
      "errors": [
        "Authentication credentials were not provided."
      ]
    }
  ],
  "error_code": "not_authenticated",
  "status_code": 401
}

404: Not Found

The request failed because the variation_ID for the requested paywall couldn’t be found. Check that the placement_id you’re requesting exists in the app and that there are no typos in it in your request.

Body

Parameter	Type	Description
errors	Object	source: (string) Always bull. errors: A description of the error.
error_code	String	Short error name. Possible value: VARIATION_DOES_NOT_EXIST_ERROR.
status_code	Integer	HTTP status. Always 404.

Response example

{
    "errors": [
        {
            "source": null,
            "errors": [
                "Variation for example_onboarding does not exist."
            ]
        }
    ],
    "error_code": "VARIATION_DOES_NOT_EXIST_ERROR",
    "status_code": 404
}