...is replaced with the URL-encoded version of a JSON
paywallConfigobject. The next section will show you how to build this object.
...is replaced with the URL-encodded address of a webpage where the user will be redirected when their membership is valid.
paywallConfigis a JSON object which includes a set of customizations for your experience. It includes the following elements:
locks: required object, a list of lock objects (see below).
icon: optional string, the URL for a icon to display in the top left corner of the modal.
callToAction: optional object, a list of messages shown based on the state of the checkout modal (see below).
persistentCheckout: optional boolean:
true__if the modal cannot be closed, defaults to
falsewhen embedded. When closed, the user will be redirected to the
redirectquery param when using a purchase address (see above).
useDelegatedProvider: optional boolean. To be announced.
network: optional integer. defaults to
1. See below.
messageToSign: optional string. If supplied, the user is prompted to sign this message using their wallet. If using a checkout URL, a
signaturequery param is then appended to the
redirectUri(see above). If using the embedded paywall, the
pessimistic: optional boolean. defaults to
false. By default, to reduce friction, we do not require users to wait for the transaction to be mined before offering them to be redirected. By setting this to
true, users will need to wait for the transaction to have been mined in order to proceed to the next step.
captcha: optional boolean. defaults to
false. If set
true, the users will be prompted to go through a captcha during the checkout process. This is better used in conjunction with a purchase hook that verifies that captcha is valid.
network: recommended integer. See below.
name: optional string. name of the lock to display.
callToActionobject lets you customize the messages displayed on the checkout UI. They are all optional strings:
default: displayed by default
expired: displayed when the user had a membership previously that expired
metadata: displayed when the user is prompted for metadata