The hosted pages provide you with all the embeds from one URL. You can change what is displayed and the configuration of them by passing in variables in the URL. There are two options to show your users the embeds:

  1. Give them a link to htttps://YOUR_SERVICEBOT_URL/page/multi
  2. Put the URL in an iframe on your website or app like so
<iframe src="https://YOUR_SERVICEBOT_URL/page/multi"></iframe>

What is displayed initially by the hosted page is determined by the options present in the url. Once the initial process of the user is completed, whether that is signup or login, the billing management page will be displayed. Below are the options for the hosted page:

  • templateId: The ID of the Service template used for the pricing page. This should be automatically assigned from the embed code. But you can set the value to the ID of any ‘Live’ Service templates. (To see a services ID, you can navigate to it from the Services tab and it is the last digits in the URL. You can also make the following API call as an admin to get all the Services: GET /service-templates)
  • paymentStructureTemplateId: The ID of the tier to display a checkout form. (To see a paymentStructure ID, navigate to the Embeds tab and select 'Checkout Page'. Select the Service, Tier, and Plan you want to have the checkout for. In the embed you will see the paymentStructureTemplateId and grab that ID. You can also make the following API call as an admin to get all the Services: GET /service-templates)
  • forceCard: Forces users to enter Credit Card. This should be set to true if you want credit card to be required during checkout. This is useful if your service has a free trial, but you still want credit card up-front.
  • setPassword: Forces users to set a password. Email is a default required field on checkout. Password is not required by default. Setting this to true will add password and password validation fields to the checkout process. If users set password up front, their account will be completed on signup, if users do not set password on checkout, they will be unable to log-in.
  • disableSeats: Set to 'true' if you do not wish to see the 'Seats' tab on the User billing management page once the user is logged in. 

Example Configurations

  • Pricing page
<iframe src="https://YOUR_SERVICEBOT_URL/page/multi?templateId=4&disableSeats=true"></iframe>
  • Checkout Form
<iframe src="https://YOUR_SERVICEBOT_URL/page/multi?templateId=4&paymentStructureTemplateId=4&disableSeats=true"></iframe>
  • Login
<iframe src="https://YOUR_SERVICEBOT_URL/page/multi?disableSeats=true"></iframe>
  • Login (with seat management)
<iframe src="https://YOUR_SERVICEBOT_URL/page/multi"></iframe>
Did this answer your question?