Get Paywall
Fetch Corrily Paywall content including Paywall design config, Plans to display, currency & price for each Plan by providing country, IP/user_id and other characteristics.
Body Params
Optional. If you know user’s id, you can pass it to stick the response to that user.
A two-letter (Alpha-2) ISO 3166 country
code.
Example: US
Optional. If you want to apply a specific paywall, you can pass it’s id.
Optional product id to coupon id mapping to explicitly specify the coupon to be applied in the pricing. Coupons feature needs to be enabled for this. example {"product_id_1": "coupon_id_1"}. Multiple coupons can be applied by a comma-delimited string, for example: {"product_id_1": "coupon_id_1,coupon_id2"}
Will override the currency of any previously saved price and instead return
the price in the currency provided. If set to true, a currency param must
be passed. Unlike override the price amount will not be recomputed.
An object containing key-value pairs of arbitrary strings that represent features of this user which may affect their optimal price. See User features. Example: {"platform": "ios"}
If set to false, will make sure no experiment is run.
A currency you wish the price to be tied to. Currencies do not need to match the passed country. For example, it is possible to return a price in EUR for someone based in the Unites Sates. Note that the country-adjusted price will be returned, regardless of the currency set.
Usage
Paywall API is used by Corrily SDK libraries (e.g. @corrily/react-sdk) to fetch Paywall data. This data is enough to render the complete Paywalls on customer’s website or mobile app. Response includes Paywall design configuration, set of Products to display, and price & currency for each Product. The response depends on the user context (country, audience, characteristics) along with currently running experiments.
design configuration- contains texts, colorus & layout config for visual customizationproducts- set of products to show on Paywall. It comes from a Package, directly liked to a Paywall, or from a Packaging Segmentation config.prices- the same data, as the/v1/pricesAPI endpoint response. Similarly to/v1/priceslogic, once User see a Paywall, he’ll be permanently sticked to the same design, set of plans and prices unless the"override": trueparameter will be sent in the API request.
Response
Whether or not the request completed successfully.