A template in Paythen is basically a set of rules you define which affects any plans created from that template. Eg: when creating a template, you set a specific billing interval, the number of payments, the currency and more. When a plan is created from this template (usually via our ecommerce plugins), it inherits these values.
The best way to get started is to create one yourself. At the moment, to see templates in your Paythen account, you need to go to Settings > Integrations and switch on the WooCommerce integration. This will enable a new menu option called "Templates".
From here, you can create new templates and manage any existing ones.
Once you create your template, we'll show your template link which is what you need to paste into our ecommerce plugins. You can also use this template link in other scenarios like in a custom integration, or via any third party tools, to pass values to it via url parameters. This will automatically generate and display a payment plan for your customers on the fly.
If you're using our ecommerce plugins, you can ignore all of the information below as it happens automatically once you've installed our plugin. Read more about our WooCommerce plugin here.
URL parameters & templates
At the moment, there are 4 dynamic values you can pass to template links. Plan name and the total payment amount are the only two that are required.
Plan name (required)
Field ID: plan_name
Total payment amount (required)
Field ID: price
Custom confirmation page (optional)
Field ID: customer_redirect_url
Field ID: description
Any values you pass here automatically overwrite any pre-set values you might have entered in the template. Eg: If you had set a description in the template, but you pass a new value for description in the url, we will use the new value in the plan.
If you're not sure about how you can pass values in the url, read our help article about utm parameters here.
Eg: A template url can have the above four values appended to it in this format:
https://[your-template-link-goes-here]?plan_name=ABC Shop Payment Plan&price=1000&description=This is a payment plan order via ABC Shop. You'll pay over 8 east instalments.&customer_redirect_url=https://abc.com/thanks
You can pass almost any value in the url parameters – including spaces, most punctuation, numbers and most symbols. From the above, we would create and show your customers a payment plan based on their total amount.
All this happens automatically behind the scenes when you're using our ecommerce plugins, like WooCommerce. But you can use the template url however you want, with any other system, as long as you pass the two required fields to it.
At the moment, templates are only available for the Payment plan plan type in Paythen. Support for the Pay your way plan type and others will be added soon.
Templates have a pre-defined currency – this means that if you have customers checking out in multiple currencies, this might not work for you at the moment. Dynamically passing the currency value is in development and we expect to add support in the near future.
We only have a WooCommerce plugin that automates the above. We are working on solutions for Shopify, Magento, and other ecommerce platforms.