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.
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"}
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.
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.
products - 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/prices logic, once User see a Paywall, he’ll be permanently sticked to the same design, set of plans and prices unless the "override": true parameter will be sent in the API request.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Corrily","colors":{"primary":"#2AB896","light":"#3DE2BB","dark":"#371BB1"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/corrily/Cn8I82iLKQofoT0a/logo/light.svg?fit=max\u0026auto=format\u0026n=Cn8I82iLKQofoT0a\u0026q=85\u0026s=1afe53d6becf6d0438247f620e7703c1","dark":"https://mintcdn.com/corrily/Cn8I82iLKQofoT0a/logo/dark.svg?fit=max\u0026auto=format\u0026n=Cn8I82iLKQofoT0a\u0026q=85\u0026s=35ccda704fe6fcae866645495262a3ef"},"api":{"mdx":{"server":null,"auth":{"method":"key","name":"X-Api-Key"}}},"footer":{"socials":{"website":"https://www.corrily.com","twitter":"https://twitter.com/usecorrily","linkedin":"https://www.linkedin.com/company/corrily"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"corrily","hasAudioNarration":false,"actualSubdomain":"corrily","customDomains":["docs.corrily.com"],"gitSource":{"type":"github","owner":"corrily","repo":"docs","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c34112ef21155ee55083","collectionId":"e8ba0cd2-8851-4efe-b256-d5ca4fa301f7","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c34112ef21155ee55083:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Documentation","count":36},{"language":"default","tag":"API Reference","count":18},{"language":"default","tag":"Users","count":7},{"language":"default","tag":"Integration Guides","count":7},{"language":"default","tag":"Price Management","count":6},{"language":"default","tag":"Experiments","count":6},{"language":"default","tag":"Products","count":5},{"language":"default","tag":"Charges","count":4},{"language":"default","tag":"Subscriptions","count":4},{"language":"default","tag":"Basics","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/get-paywall","slug":"/api-reference/get-paywall","pageMetadata":{"title":"Get Paywall","description":"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026 price for each Plan by providing country, IP/user_id and other characteristics.","api":"POST https://client.corrily.com/v1/paywall","href":"/api-reference/get-paywall"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026 price for each Plan by providing country, IP/user_id and other characteristics.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`body-params`,children:`Body Params`}),`\n`,_jsx(ParamField,{body:`user_id`,type:`string`,id:`param-user-id`,children:_jsx(_components.p,{children:`Optional. If you know user’s id, you can pass it to stick the response to that user.`})}),`\n`,_jsx(ParamField,{body:`country`,type:`string`,id:`param-country`,children:_jsxs(_components.p,{children:[`A two-letter (Alpha-2) `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes#Current_ISO_3166_country_codes`,children:`ISO 3166 country\ncode`}),`.\nExample: `,_jsx(_components.code,{children:`US`})]})}),`\n`,_jsx(ParamField,{body:`paywall_id`,type:`string`,id:`param-paywall-id`,children:_jsx(_components.p,{children:`Optional. If you want to apply a specific paywall, you can pass it’s id.`})}),`\n`,_jsx(ParamField,{body:`coupons`,type:`object`,id:`param-coupons`,children:_jsxs(_components.p,{children:[`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 `,_jsx(_components.code,{children:`{\"product_id_1\": \"coupon_id_1\"}`}),`. Multiple coupons can be applied by a comma-delimited string, for example: `,_jsx(_components.code,{children:`{\"product_id_1\": \"coupon_id_1,coupon_id2\"}`})]})}),`\n`,_jsx(ParamField,{body:`override_currency`,type:`boolean`,id:`param-override-currency`,children:_jsxs(_components.p,{children:[`Will override the currency of any previously saved price and instead return\nthe price in the currency provided. If set to `,_jsx(_components.code,{children:`true`}),`, a `,_jsx(_components.code,{children:`currency`}),` param must\nbe passed. Unlike `,_jsx(_components.code,{children:`override`}),` the price amount will `,_jsx(_components.em,{children:`not`}),` be recomputed.`]})}),`\n`,_jsx(ParamField,{body:`features`,type:`object`,id:`param-features`,children:_jsxs(_components.p,{children:[`An object containing key-value pairs of arbitrary strings that represent features of this user which may affect their optimal price. See `,_jsx(_components.a,{href:`/users/02_user-features`,children:`User features`}),`. Example: `,_jsx(_components.code,{children:`{\"platform\": \"ios\"}`})]})}),`\n`,_jsx(ParamField,{body:`run_experiment`,type:`boolean`,id:`param-run-experiment`,children:_jsx(_components.p,{children:`If set to false, will make sure no experiment is run.`})}),`\n`,_jsx(ParamField,{body:`currency`,type:`string`,id:`param-currency`,children:_jsx(_components.p,{children:`A currency you wish the price to be tied to. Currencies do not need to match\nthe passed country. For example, it is possible to return a price in EUR for\nsomeone based in the Unites Sates. Note that the country-adjusted price will\nbe returned, regardless of the currency set.`})}),`\n`,_jsx(Heading,{level:`2`,id:`usage`,children:`Usage`}),`\n`,_jsxs(_components.p,{children:[`Paywall API is used by Corrily SDK libraries (e.g. `,_jsx(_components.a,{href:`/basics/00_introduction`,children:`@corrily/react-sdk`}),`) to fetch Paywall data.\nThis data is enough to render the complete Paywalls on customer’s website or mobile app.\nResponse includes Paywall design configuration, set of Products to display, and price \u0026 currency for each Product.\nThe response depends on the user context (country, audience, characteristics) along with currently running experiments.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`design configuration`}),` - contains texts, colorus \u0026 layout config for visual customization`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`products`}),` - set of products to show on Paywall. It comes from a Package, directly liked to a Paywall, or from a Packaging Segmentation config.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`prices`}),` - the same data, as the `,_jsx(_components.code,{children:`/v1/prices`}),` `,_jsx(_components.a,{href:`/api-reference/calculate-price`,children:`API endpoint`}),` response. Similarly to `,_jsx(_components.code,{children:`/v1/prices`}),` logic, once User see a Paywall, he’ll be permanently sticked to the same design, set of plans and prices unless the `,_jsx(_components.code,{children:`\"override\": true`}),` parameter will be sent in the API request.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`success`,type:`boolean`,id:`param-success`,children:_jsx(_components.p,{children:`Whether or not the request completed successfully.`})}),`\n`,_jsx(ResponseField,{name:`pricing_page`,type:`object`,id:`param-pricing-page`,children:_jsxs(Expandable,{title:`pricing_page`,children:[_jsx(ResponseField,{name:`id`,type:`integer`,id:`param-id`,children:_jsx(_components.p,{children:`Id of the paywall`})}),_jsx(ResponseField,{name:`is_default`,type:`boolean`,id:`param-is-default`,children:_jsx(_components.p,{children:`Is it a default paywall or not`})}),_jsx(ResponseField,{name:`buttons_caption`,type:`string`,id:`param-buttons-caption`,children:_jsx(_components.p,{children:`Default buttons’ caption`})}),_jsx(ResponseField,{name:`buttons_color`,type:`string`,id:`param-buttons-color`,children:_jsx(_components.p,{children:`Default buttons’ color`})}),_jsx(ResponseField,{name:`background_color`,type:`string`,id:`param-background-color`,children:_jsx(_components.p,{children:`Background color`})}),_jsx(ResponseField,{name:`collapse_features`,type:`boolean`,id:`param-collapse-features`,children:_jsx(_components.p,{children:`Should similar features in products be collapsed or not`})}),_jsx(ResponseField,{name:`show_product_description`,type:`boolean`,id:`param-show-product-description`,children:_jsx(_components.p,{children:`Show product description`})}),_jsx(ResponseField,{name:`header`,type:`string`,id:`param-header`,children:_jsx(_components.p,{children:`Header text abore the paywall`})}),_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Text between title and paywall`})}),_jsx(ResponseField,{name:`show_header`,type:`boolean`,id:`param-show-header`,children:_jsx(_components.p,{children:`Show header with description or not`})}),_jsx(ResponseField,{name:`show_annual_discount_percentage`,type:`boolean`,id:`param-show-annual-discount-percentage`,children:_jsx(_components.p,{children:`Show annual discount percentage number near a monthly/annual switcher`})}),_jsx(ResponseField,{name:`show_feature_comparison_table`,type:`boolean`,id:`param-show-feature-comparison-table`,children:_jsx(_components.p,{children:`Show feature comparison table below a paywall`})}),_jsx(ResponseField,{name:`feature_comparison_table_text`,type:`string`,id:`param-feature-comparison-table-text`,children:_jsx(_components.p,{children:`Text on the button for showing feature comparison table`})}),_jsx(ResponseField,{name:`features_badges`,type:`object`,id:`param-features-badges`,children:_jsx(_components.p,{children:`An object, where:\nkey - feature api id\nvalue - badge title`})})]})}),`\n`,_jsx(ResponseField,{name:`products`,type:`object[]`,id:`param-products`,children:_jsxs(Expandable,{title:`product`,children:[_jsx(ResponseField,{name:`id`,type:`integer`,id:`param-id-1`,children:_jsx(_components.p,{children:`Id of the product`})}),_jsx(ResponseField,{name:`api_id`,type:`string`,id:`param-api-id`,children:_jsx(_components.p,{children:`Text unique id between organization’s products`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Name of the product`})}),_jsx(ResponseField,{name:`interval`,type:`enum`,id:`param-interval`,children:_jsx(_components.p,{children:`“month” or “year”`})}),_jsx(ResponseField,{name:`interval_count`,type:`integer`,id:`param-interval-count`,children:_jsx(_components.p,{children:`The period between payments`})}),_jsx(ResponseField,{name:`cents`,type:`boolean`,id:`param-cents`,children:_jsx(_components.p,{children:`Optional`})}),_jsx(ResponseField,{name:`recurrent_horizon`,type:`string`,id:`param-recurrent-horizon`,children:_jsx(_components.p,{children:`Optional`})}),_jsx(ResponseField,{name:`group`,type:`integer`,id:`param-group`,children:_jsx(_components.p,{children:`Optional`})}),_jsx(ResponseField,{name:`price`,type:`string`,id:`param-price`,children:_jsx(_components.p,{children:`Optional`})}),_jsx(ResponseField,{name:`price_usd`,type:`string`,id:`param-price-usd`,children:_jsx(_components.p,{children:`Optional`})}),_jsxs(ResponseField,{name:`trial`,type:`object`,id:`param-trial`,children:[_jsx(_components.p,{children:`Optional`}),_jsxs(Expandable,{title:`trial`,children:[_jsx(ResponseField,{name:`id`,type:`integer`,id:`param-id-2`,children:_jsx(_components.p,{children:`Id of the trial`})}),_jsx(ResponseField,{name:`trial_days`,type:`integer`,id:`param-trial-days`,children:_jsx(_components.p,{children:`Number of days provided by a trial`})}),_jsx(ResponseField,{name:`trial_type`,type:`string`,id:`param-trial-type`,children:_jsx(_components.p,{children:`Type of the trial`})})]})]}),_jsxs(ResponseField,{name:`product_metadata`,type:`object`,id:`param-product-metadata`,children:[_jsx(_components.p,{children:`Optional`}),_jsx(Expandable,{title:`product_metadata`,children:_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-1`,children:_jsx(_components.p,{children:`Description override for a product in a paywall`})})})]}),_jsxs(ResponseField,{name:`features`,type:`object[]`,id:`param-features-1`,children:[_jsx(_components.p,{children:`Optional`}),_jsxs(Expandable,{title:`feature`,children:[_jsx(ResponseField,{name:`id`,type:`integer`,id:`param-id-3`,children:_jsx(_components.p,{children:`Id of the feature`})}),_jsx(ResponseField,{name:`api_id`,type:`string`,id:`param-api-id-1`,children:_jsx(_components.p,{children:`Text id of the feature`})}),_jsx(ResponseField,{name:`type`,type:`enum`,id:`param-type`,children:_jsx(_components.p,{children:`Feature type: “numeric”, “boolean”`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:_jsx(_components.p,{children:`Feature’s name`})}),_jsx(ResponseField,{name:`value`,type:`integer`,id:`param-value`,children:_jsx(_components.p,{children:`Optional. Value exists only for numeric features`})}),_jsx(ResponseField,{name:`value_id`,type:`integer`,id:`param-value-id`,children:_jsx(_components.p,{children:`Id of the feature value`})}),_jsx(ResponseField,{name:`unit`,type:`string`,id:`param-unit`,children:_jsx(_components.p,{children:`Title for the unit\nOptional`})}),_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-2`,children:_jsx(_components.p,{children:`Feature description`})}),_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsx(_components.p,{children:`Feature status: “draft”, “active”`})}),_jsxs(ResponseField,{name:`feature_group`,type:`object`,id:`param-feature-group`,children:[_jsx(_components.p,{children:`Feature status: “draft”, “active”`}),_jsxs(Expandable,{title:`feature_group`,children:[_jsx(ResponseField,{name:`id`,type:`integer`,id:`param-id-4`,children:_jsx(_components.p,{children:`Feature group id`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-2`,children:_jsx(_components.p,{children:`Feature group name`})})]})]})]})]}),_jsxs(ResponseField,{name:`overrides`,type:`object`,id:`param-overrides`,children:[_jsx(_components.p,{children:`Optional. Object with additional override info for a product`}),_jsx(ResponseField,{name:`button_caption`,type:`string`,id:`param-button-caption`,children:_jsx(_components.p,{children:`Optional. Override for a button caption of the product`})}),_jsx(ResponseField,{name:`button_color`,type:`string`,id:`param-button-color`,children:_jsx(_components.p,{children:`Optional. Override for a button color of the product`})}),_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description-3`,children:_jsx(_components.p,{children:`Optional. Override for a description of the product`})}),_jsx(ResponseField,{name:`badge`,type:`string`,id:`param-badge`,children:_jsx(_components.p,{children:`Optional. Override for a badge of the product`})}),_jsx(ResponseField,{name:`card_color`,type:`string`,id:`param-card-color`,children:_jsx(_components.p,{children:`Optional. Override for a color of the product card`})}),_jsx(ResponseField,{name:`button_url`,type:`string`,id:`param-button-url`,children:_jsx(_components.p,{children:`Optional. Url for a redirect on click the product’s button`})}),_jsx(ResponseField,{name:`price_is_hidden`,type:`string`,id:`param-price-is-hidden`,children:_jsx(_components.p,{children:`Optional. Flag: is product’s price hidden, or not`})}),_jsx(ResponseField,{name:`price_override_text`,type:`string`,id:`param-price-override-text`,children:_jsx(_components.p,{children:`Optional. Override for a product’s price`})})]})]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Paywall","description":"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026 price for each Plan by providing country, IP/user_id and other characteristics.","api":"POST https://client.corrily.com/v1/paywall","href":"/api-reference/get-paywall"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Body Params","slug":"body-params","depth":2,"children":[]},{"title":"Usage","slug":"usage","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Get Paywall","path":"/v1/paywall","servers":[{"url":"https://client.corrily.com"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"X-Api-Key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"user_id":[{"type":"string","description":"Optional. If you know user’s id, you can pass it to stick the response to that user."}],"country":[{"type":"string","description":"A two-letter (Alpha-2) ISO 3166 country code . Example: `US`"}],"paywall_id":[{"type":"string","description":"Optional. If you want to apply a specific paywall, you can pass it’s id."}],"coupons":[{"type":"object","properties":{},"description":"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\"}`"}],"override_currency":[{"type":"boolean","description":"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."}],"features":[{"type":"object","properties":{},"description":"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\"}`"}],"run_experiment":[{"type":"boolean","description":"If set to false, will make sure no experiment is run."}],"currency":[{"type":"string","description":"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."}]}}],"examples":{"example":{"value":{"user_id":"\u003cstring>","country":"\u003cstring>","paywall_id":"\u003cstring>","coupons":{},"override_currency":true,"features":{},"run_experiment":true,"currency":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"success":[{"type":"boolean","description":"Whether or not the request completed successfully."}],"pricing_page":[{"type":"object","properties":{"id":[{"type":"integer","description":"Id of the paywall"}],"is_default":[{"type":"boolean","description":"Is it a default paywall or not"}],"buttons_caption":[{"type":"string","description":"Default buttons’ caption"}],"buttons_color":[{"type":"string","description":"Default buttons’ color"}],"background_color":[{"type":"string","description":"Background color"}],"collapse_features":[{"type":"boolean","description":"Should similar features in products be collapsed or not"}],"show_product_description":[{"type":"boolean","description":"Show product description"}],"header":[{"type":"string","description":"Header text abore the paywall"}],"description":[{"type":"string","description":"Text between title and paywall"}],"show_header":[{"type":"boolean","description":"Show header with description or not"}],"show_annual_discount_percentage":[{"type":"boolean","description":"Show annual discount percentage number near a monthly/annual switcher"}],"show_feature_comparison_table":[{"type":"boolean","description":"Show feature comparison table below a paywall"}],"feature_comparison_table_text":[{"type":"string","description":"Text on the button for showing feature comparison table"}],"features_badges":[{"type":"object","properties":{},"description":"An object, where: key - feature api id value - badge title"}]}}],"products":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"integer","description":"Id of the product"}],"api_id":[{"type":"string","description":"Text unique id between organization’s products"}],"name":[{"type":"string","description":"Name of the product"}],"interval":[{"type":"object","properties":{},"description":"“month” or “year”"}],"interval_count":[{"type":"integer","description":"The period between payments"}],"cents":[{"type":"boolean","description":"Optional"}],"recurrent_horizon":[{"type":"string","description":"Optional"}],"group":[{"type":"integer","description":"Optional"}],"price":[{"type":"string","description":"Optional"}],"price_usd":[{"type":"string","description":"Optional"}],"trial":[{"type":"object","properties":{"id":[{"type":"integer","description":"Id of the trial"}],"trial_days":[{"type":"integer","description":"Number of days provided by a trial"}],"trial_type":[{"type":"string","description":"Type of the trial"}]},"description":"Optional"}],"product_metadata":[{"type":"object","properties":{"description":[{"type":"string","description":"Description override for a product in a paywall"}]},"description":"Optional"}],"features":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"integer","description":"Id of the feature"}],"api_id":[{"type":"string","description":"Text id of the feature"}],"type":[{"type":"object","properties":{},"description":"Feature type: “numeric”, “boolean”"}],"name":[{"type":"string","description":"Feature’s name"}],"value":[{"type":"integer","description":"Optional. Value exists only for numeric features"}],"value_id":[{"type":"integer","description":"Id of the feature value"}],"unit":[{"type":"string","description":"Title for the unit Optional"}],"description":[{"type":"string","description":"Feature description"}],"status":[{"type":"string","description":"Feature status: “draft”, “active”"}],"feature_group":[{"type":"object","properties":{"id":[{"type":"integer","description":"Feature group id"}],"name":[{"type":"string","description":"Feature group name"}]},"description":"Feature status: “draft”, “active”"}]}}],"description":"Optional"}],"overrides":[{"type":"object","properties":{"button_caption":[{"type":"string","description":"Optional. Override for a button caption of the product"}],"button_color":[{"type":"string","description":"Optional. Override for a button color of the product"}],"description":[{"type":"string","description":"Optional. Override for a description of the product"}],"badge":[{"type":"string","description":"Optional. Override for a badge of the product"}],"card_color":[{"type":"string","description":"Optional. Override for a color of the product card"}],"button_url":[{"type":"string","description":"Optional. Url for a redirect on click the product’s button"}],"price_is_hidden":[{"type":"string","description":"Optional. Flag: is product’s price hidden, or not"}],"price_override_text":[{"type":"string","description":"Optional. Override for a product’s price"}]},"description":"Optional. Object with additional override info for a product"}]}}]}]}}],"examples":{"example":{"value":{"success":true,"pricing_page":{"id":123,"is_default":true,"buttons_caption":"\u003cstring>","buttons_color":"\u003cstring>","background_color":"\u003cstring>","collapse_features":true,"show_product_description":true,"header":"\u003cstring>","description":"\u003cstring>","show_header":true,"show_annual_discount_percentage":true,"show_feature_comparison_table":true,"feature_comparison_table_text":"\u003cstring>","features_badges":{}},"products":[{"id":123,"api_id":"\u003cstring>","name":"\u003cstring>","interval":{},"interval_count":123,"cents":true,"recurrent_horizon":"\u003cstring>","group":123,"price":"\u003cstring>","price_usd":"\u003cstring>","trial":{"id":123,"trial_days":123,"trial_type":"\u003cstring>"},"product_metadata":{"description":"\u003cstring>"},"features":[{"id":123,"api_id":"\u003cstring>","type":{},"name":"\u003cstring>","value":123,"value_id":123,"unit":"\u003cstring>","description":"\u003cstring>","status":"\u003cstring>","feature_group":{"id":123,"name":"\u003cstring>"}}],"overrides":{"button_caption":"\u003cstring>","button_color":"\u003cstring>","description":"\u003cstring>","badge":"\u003cstring>","card_color":"\u003cstring>","button_url":"\u003cstring>","price_is_hidden":"\u003cstring>","price_override_text":"\u003cstring>"}}]}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"corrily","siteName":"Corrily","title":"Get Paywall - Corrily","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-02T07:17:21.763Z","originalFileLocation":"api-reference/get-paywall.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026amp; price for each Plan by providing country, IP/user_id and other characteristics.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Corrily\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Paywall - Corrily\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026amp; price for each Plan by providing country, IP/user_id and other characteristics.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Corrily\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.corrily.com/api-reference/get-paywall\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://corrily.mintlify.app/_mintlify/api/og/v2?division=Paywall\u0026amp;title=Get+Paywall\u0026amp;description=Fetch+Corrily+Paywall+content+including+Paywall+design+config%2C+Plans+to+display%2C+currency+%26+price+for+each+Plan+by+providing+country%2C+IP%2Fuser_id+and+other+chara\u0026amp;theme=a21d30a3f45764629d86f2da\u0026amp;signature=6f902c5efb435098b17c63d0c018b86ce1d214b56de5df6e0926137746462685\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Paywall - Corrily\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026amp; price for each Plan by providing country, IP/user_id and other characteristics.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://corrily.mintlify.app/_mintlify/api/og/v2?division=Paywall\u0026amp;title=Get+Paywall\u0026amp;description=Fetch+Corrily+Paywall+content+including+Paywall+design+config%2C+Plans+to+display%2C+currency+%26+price+for+each+Plan+by+providing+country%2C+IP%2Fuser_id+and+other+chara\u0026amp;theme=a21d30a3f45764629d86f2da\u0026amp;signature=6f902c5efb435098b17c63d0c018b86ce1d214b56de5df6e0926137746462685\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/corrily/gXHpgCTf7BKZKcpb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Corrily\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2AB896\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.corrily.com/api-reference/get-paywall\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/get-paywall.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.corrily.com/#organization\",\"name\":\"Corrily\",\"url\":\"https://docs.corrily.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/corrily/Cn8I82iLKQofoT0a/logo/light.svg?fit=max\u0026auto=format\u0026n=Cn8I82iLKQofoT0a\u0026q=85\u0026s=1afe53d6becf6d0438247f620e7703c1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.corrily.com#website\",\"name\":\"Corrily\",\"url\":\"https://docs.corrily.com\",\"publisher\":{\"@id\":\"https://docs.corrily.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.corrily.com/api-reference/get-paywall#webpage\",\"url\":\"https://docs.corrily.com/api-reference/get-paywall\",\"name\":\"Get Paywall\",\"description\":\"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026 price for each Plan by providing country, IP/user_id and other characteristics.\",\"dateModified\":\"2026-01-02T07:17:21.763Z\",\"isPartOf\":{\"@id\":\"https://docs.corrily.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.corrily.com/api-reference/get-paywall#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.corrily.com/api-reference/get-paywall#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Corrily\",\"item\":\"https://docs.corrily.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Paywall\",\"item\":\"https://docs.corrily.com/api-reference/get-paywall\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.corrily.com/api-reference/get-paywall#apireference\",\"headline\":\"Get Paywall\",\"name\":\"Get Paywall\",\"description\":\"Fetch Corrily Paywall content including Paywall design config, Plans to display, currency \u0026 price for each Plan by providing country, IP/user_id and other characteristics.\",\"url\":\"https://docs.corrily.com/api-reference/get-paywall\",\"mainEntityOfPage\":{\"@id\":\"https://docs.corrily.com/api-reference/get-paywall#webpage\"},\"dateModified\":\"2026-01-02T07:17:21.763Z\",\"publisher\":{\"@id\":\"https://docs.corrily.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.corrily.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Corrily\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Corrily","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/basics/00_introduction"}]},{"anchor":"API Reference","icon":"rectangle-terminal","groups":[{"group":"Prices","pages":[{"title":"Calculate price","description":"Calculate a localized or optimized price for your service or product based on the customer's location and other characteristics.","api":"POST https://client.corrily.com/v1/prices","href":"/api-reference/calculate-price"}]},{"group":"Paywall","pages":[{"title":"Get Paywall","api":"POST https://client.corrily.com/v1/paywall","href":"/api-reference/get-paywall"}]},{"group":"Users","pages":[{"title":"Identify Call","description":"Link IPs to users and update user features.","api":"POST https://client.corrily.com/v1/identify","href":"/api-reference/set-user-characteristics"},{"title":"Get User country","api":"GET https://client.corrily.com/v1/users/{user_id}","href":"/api-reference/get-user-details"}]},{"group":"Subscriptions","pages":[{"title":"Create subscription","api":"POST https://client.corrily.com/v1/subscriptions","href":"/api-reference/create-subscription"},{"title":"Get subscription","api":"GET https://client.corrily.com/v1/subscriptions/{user_id}/{origin}/{origin_id}","href":"/api-reference/get-subscription"},{"title":"Update subscription","api":"POST https://client.corrily.com/v1/subscriptions/{user_id}/{origin}/{origin_id}","href":"/api-reference/update-subscription"},{"title":"Delete subscription","api":"DELETE https://client.corrily.com/v1/subscriptions/{user_id}/{origin}/{origin_id}","href":"/api-reference/delete-subscription"}]},{"group":"Charges","pages":[{"title":"Create charge","api":"POST https://client.corrily.com/v1/charges","href":"/api-reference/create-charge"},{"title":"Get charge","api":"GET https://client.corrily.com/v1/charges/{user_id}/{origin}/{origin_id}","href":"/api-reference/get-charge"},{"title":"Update charge","api":"POST https://client.corrily.com/v1/charges/{user_id}/{origin}/{origin_id}","href":"/api-reference/update-charge"},{"title":"Delete charge","api":"DELETE https://client.corrily.com/v1/charges/{user_id}/{origin}/{origin_id}","href":"/api-reference/delete-charge"}]},{"group":"Products","pages":[{"title":"Create Product","api":"POST https://client.corrily.com/v1/products","href":"/api-reference/create-product"},{"title":"Get Product","api":"GET https://client.corrily.com/v1/products/{product_api_id}","href":"/api-reference/get-product"},{"title":"Get All Products","api":"GET https://client.corrily.com/v1/products","href":"/api-reference/get-all-products"},{"title":"Update Product","api":"POST https://client.corrily.com/v1/products","href":"/api-reference/update-product"},{"title":"Delete Product","api":"DELETE https://client.corrily.com/v1/products/{product_api_id}","href":"/api-reference/delete-product"}]},{"group":"Coupons","pages":[{"title":"Get Coupons","api":"GET https://client.corrily.com/v1/coupons","href":"/api-reference/get-coupons"}]}]},{"anchor":"Implementation Examples","href":"https://github.com/corrily/integration-examples","icon":"github"}]},"basePath":"","title":"Get Paywall - Corrily","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js"]}