Sign in

v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

Create paywall

post/paywalls

Headers

api_keystring required

Request body

slugstring required
namestring required
payment_system'stripe' | 'paddle' | 'paypal' | 'revenuecat' | 'adapty' | 'qonversion' | 'cloudpayments' | 'primer' required
comparison_period'day' | 'week' | 'month' | 'year' nullable
themestring nullable
languagestring nullable
countrystring nullable

ISO 3166-1 alpha-2 country code

plansinteger[] required
custom_head_htmlstring nullable
custom_cssstring nullable
tagsstring[]
source_paywallinteger nullable
auto_languagesinteger nullable
templates_version1 | 2 nullable

Paywall templates version. Defaults to 2 when omitted.

published_versioninteger nullable
css_variablesobject nullable
screensstring json nullable

JSON string with paywall screens content

Example request

{
  "prices": [
    {
      "after_pay_redirect": {
        "id": 24757
      }
    }
  ],
  "after_pay_redirect": {
    "id": 24757
  }
}

Response

Paywall created

successinteger

Example response

{
  "paywall": {
    "id": 210,
    "project_id": 78,
    "slug": "api-paywall",
    "name": "API Paywall",
    "payment_system": "stripe",
    "after_pay_redirect": {
      "id": 24757
    },
    "prices": [
      {
        "after_pay_redirect": {
          "id": 24757
        }
      }
    ],
    "source_data": "JSON"
  }
}