Introduction
This guide will help you install and set up the SubscriptionFlow WordPress plugin to enable a Paywall on your website, manage subscriptions, and streamline payment processes. Follow these steps to ensure a smooth setup and integration
Step 1: Install the WordPress Paywall Plugin
Access the WordPress Dashboard
- Log in to your WordPress admin dashboard.
- Navigate to the side panel.
- Go to Plugins and click on Add New.
Upload the .zip File
- At the top of the page, click Upload Plugin.
- Select Choose File, locate the SubscriptionFlow plugin pw-sf-integration.zip file on your computer, and click Install Now.
Note: If you don’t have the .zip file, please reach out to the support team for assistance in obtaining it.
Activate the Plugin
- Once the plugin is uploaded, click Activate to enable it on your site.
Step 2: Configure SubscriptionFlow Plugin Settings
Access SF Settings
- In the WordPress sidebar, find SF Settings and click to open the SF Settings page.
Enter SubscriptionFlow Client Credentials
To get your client credentials, log into your SubscriptionFlow instance.
- Navigate to Settings > Apps & API, and choose API Keys
- Enter Client Name and click on the Create Client button.
- Client ID and Client Secret Key will be generated.
- Paste your Client ID Key, Client Secret Key, and Domain URL from your SubscriptionFlow account into the respective fields in the SF Settings in WordPress.
- Select the User Role and enter the Restrict Content Message to display to users, prompting them to purchase a subscription plan for access. Additionally, you can set the Customer Email Text for communication purposes.
- Customize the Labels, URLs, Bypass Restrictions, and Lead-in Elements to suit your preferences, then click Save Changes.
- When a customer is synced from SF to the website, a login email will be sent to their email address. You can edit this text in the field below.
- If you want to show part of the post, you can set the number of words before the paywall box.
- The Bypass Restrictions option can be set using the checkboxes below.
- If you haven't installed any plugin for the login form, you can use our below short code to display the form on any page [pw_sf_ajax_login_form]
- You can customize the button, label, and redirect URL using the options below
- Before enabling the Paywall box, you need to fetch the SubscriptionFlow products by clicking the 'Get Subscription Product' button. This will save all SubscriptionFlow products to the WordPress database. Whenever you create a new product in SubscriptionFlow, simply click this button again to update the database
- If you want to import customers from SubscriptionFlow to WordPress, click the 'Import Customers from SubscriptionFlow' button. This will import customer information along with their plans and subscription statuses
- If you want to add the Paywall box to custom taxonomies, please enter the name of the taxonomy following the placeholder in the field.
- You can add Paywall restrictions to any Post, Tag, Category, or Page. You can also assign Plans.
- Customers who purchase any of these plans will then be able to access the content.
- If 1 or 2 posts are free within a restricted Category/Tag, you can set the free Post option using the checkbox below.
Step 3: Sync Customers from SubscriptionFlow to the Website
To sync customers from SubscriptionFlow to the website, add a webhook to the SubscriptionFlow account.
- Navigate to Settings > Automation, and choose Webhooks
- Click on Configure Webhook button
- Please select and enter the data as illustrated in the following images, and click the Save button.
- Enter below URL in URL to Notify
https://example.com/wp-json/api/sf-pw-create-update-user
Step 4: Create a SubscriptionFlow Workflow to Restrict WordPress Content Based on Subscription Status
- Create a workflow in SubscriptionFlow to trigger when the Status(Field) of any subscription changes.
- Navigate to SubscriptionFlow Settings > Automation, and choose Workflows
- Click on Create Workflow button
- Enter Webhook Name and choose Module
- Choose on Record Action from trigger workflow, choose Field Update and then choose Status from the dropdown and Click the Save button.
- Click on the + icon and choose Webhook
Please select and enter the data as illustrated in the following image, and click the Save button.
- Enter Name, URL example https://example.com/wp-json/api/sf-pw-create-update-user ,
Append Entity Parameters
- Enter customer_id in Parameter Name. Choose Subscriptions from the Parameter Value and choose Id.
Append Customers Parameters
- Enter Parameter Name pw_sf_allow_content_access and Parameter Value: allow and click the Save button.
- Your webhook and workflow are now set up. Each time a customer attempts to access restricted content on your website, they’ll see a limited view and will need to purchase a subscription plan to gain full access.
- You can get your Hosted Payment Page links from the SubscriptionFlow Products/Publications detail view page
- You can add this link to the Paywall Subscribe button if you have only one product and plan. If you have 2 or 3 plans on a separate page of your website, you need to create products and plans with the same price in SubscriptionFlow and get the HPP links as shown in the screenshot above. Then, you can add these links to any page on your website.
Example:
- Click the Subscribe Now button to view available plans. You’ll then be redirected to the checkout page to complete payment.
You can use the function below to lock of articles in a custom template. The function will return false if the user is not signed in. It will also return false if the user has a subscription that does not match the plan or category assigned to the current article in the dashboard. If it matches, the function will return true
if (pw_sf_is_user_plan_status_active()) {
// Code for active user plan
} else {
// Code for inactive user plan
}
We have a PHP function that you can use. The function below checks whether any plan in the array is active for the logged-in customer.
This function returns true if the subscription status of any plan is active; otherwise, it returns false.
$pw_sf_target_plan_ids = array('1378-4711-99e5-05a77981ea84', '1378-4711-99e5-05a77981ea84');
if (sf_pw_userlogin_restriction($pw_sf_target_plan_ids)) {
// Code for active plan
} else {
// Code for inactive plan
}
Comments
0 comments
Please sign in to leave a comment.