WHMCS Billing Module for StreamCreed - Revision history

Admin: /* Requirements */

2021-04-07T21:49:07Z

Requirements

← Older revision		Revision as of 21:49, 7 April 2021
Line 7:		Line 7:

	Requirement Minimum Recommended PHP Version 7.2 Latest 7.3 or 7.4 Release PHP Memory Limit 64MB 128MB**		Requirement Minimum Recommended PHP Version 7.2 Latest 7.3 or 7.4 Release PHP Memory Limit 64MB 128MB**

			If you are using shared hosting your provider may be blocking outbound ports. Most Shared hosting providers do this. Contact your hosting provider and get them to open the port that your reseller panel is on. i.e Streamcreed runs on either port 80 or port 443. Most providers will open the port.
			We have our own CPanel servers that will work out of the box. [https://xtreamresell.com/index.php?rp=/store/cpanel-shared-hosting click here for pricing]

	== Installation and Configuration ==		== Installation and Configuration ==

Admin: /* Configuring Reseller Credits */

2021-04-03T21:10:25Z

Configuring Reseller Credits

← Older revision		Revision as of 21:10, 3 April 2021
Line 222:		Line 222:

	[[File:step26.jpg\|800px]]		[[File:step26.jpg\|800px]]

			=== Troubleshooting ===

			'''''I can't see my products in the module settings.'''''

			If you are using shared hosting your provider may be blocking outbound ports. Most Shared hosting providers do this. Contact your hosting provider and get them to open the port that your reseller panel is on. i.e Streamcreed runs on either port 80 or port 443. Most providers will open the port.
			We have our own CPanel servers that will work out of the box. [https://xtreamresell.com/index.php?rp=/store/cpanel-shared-hosting click here for pricing]
			----

			'''''My licence has expired but its a valid license'''''

			In Whmcs go to "System Settings" > "Addon Modules".

			Click Deactivate.
			Click Activate.
			Click Configure. Paste your License Key in again, Check the box "Full Administrator" and click Save. (Don't miss a step).
			----

Admin: /* How to Configure */

2021-04-03T21:07:03Z

How to Configure

← Older revision		Revision as of 21:07, 3 April 2021
Line 52:		Line 52:

	=== How to Configure ===		=== How to Configure ===

			8. Enable "Attempt to load all files" in "Encoded File Loading" by doing this. Click "System Settings" > "General Setting" > "Other" and check the box "Attempt to load all files".

			[[File:Xtreamui16.png\|800px]]

	9. In order to create and configure a product, go to 'System Settings' → 'Products/Services'.		9. In order to create and configure a product, go to 'System Settings' → 'Products/Services'.

Admin: /* How to License */

2021-04-03T21:06:44Z

How to License

← Older revision		Revision as of 21:06, 3 April 2021
Line 47:		Line 47:
	6. Click Activate.		6. Click Activate.

	7. Click Configure.		7. Click Configure. Paste your License Key in, Check the box "Full Administrator" and click Save.

	8. Paste your License Key in, Check the box "Full Administrator" and click Save.

	[[File:Streamcreed6.jpg\|800px]]		[[File:Streamcreed6.jpg\|800px]]

Admin at 17:31, 28 March 2021

2021-03-28T17:31:59Z

← Older revision		Revision as of 17:31, 28 March 2021
Line 204:		Line 204:

	[[File:step23.jpg\|500px]]		[[File:step23.jpg\|500px]]

			=== Configuring Reseller Credits ===

			To add a product to automatically provision Reseller credits add the product normally. There are a few small differences we will explain here.

			31. For Reseller Credits, in the Pricing tab set Billing to "One Time".

			[[File:step24.jpg\|800px]]

			32. In Module settings select the check box "Reseller Credits" and set the "Credit Amount" field to the amount of credits to be added to the reseller account.

			[[File:Xtreamui15.png\|800px]]

			33. In "Custom Fields" set the "Field Name" to "Reseller" this must start with a capital R. Set "Required Field" > on "Show on Order Form" > on "Show on Invoice" > on.

			[[File:step26.jpg\|800px]]

Admin at 17:30, 28 March 2021

2021-03-28T17:30:43Z

← Older revision		Revision as of 17:30, 28 March 2021
Line 108:		Line 108:

	23. Click "save" your product has now been setup.		23. Click "save" your product has now been setup.

			=== Setting up Email templates ===

			24. Now we need to setup the Email templates. Go to "System Settings" > "Email Templates". Click "Create New Email Template".

			[[File:step20.jpg\|800px]]

			25. For "Email Type" select "Product/Service". NOTE: It will default to "General" make sure to change that to "Product/Service". For "Unique Name" enter "New Account Information" NOTE; it must be called exactly that and is case-sensitive. Click create.

			[[File:step21.jpg\|800px]]

			26. For "Subject" again enter "New Account Information" exactly like that. Change "Font Family" to "Courier New" This will make sure Alpha Numeric characters are show properly i.e l and L. Next paste the below test in and click save. NOTE you can edit this but take Note of the service fields such as {$service_username} etc. The {$service_domain} field is retrieved from the earlier module field "Domain URL"


			Dear {$client_name},


			Your order for {$service_product_name} has now been activated. Please keep this message for your records.
			Product Details are :

			Product/Service: {$service_product_name}

			Payment Method: {$service_payment_method}

			Amount: {$service_recurring_amount}

			Billing Cycle: {$service_billing_cycle}

			Next Due Date: {$service_next_due_date}



			Your M3U is :

			NOTE: This is Case Sensitive:

			{$service_domain}get.php?username={$service_username}&password={$service_password}&type=m3u_plus&output=ts

			Your Electronic Programme Guide is:

			{$service_domain}xmltv.php?username={$service_username}&password={$service_password}

			Login Details :

			Server={$service_domain}

			Username :{$service_username}

			Password : {$service_password}

			Thanks for choosing us.

			{$signature}

			27. If you use MAG boxes please create a new template with the following as well For "Email Type" select "Product/Service". NOTE: It will default to "General" make sure to change that to "Product/Service". For "Unique Name" enter " New Account Information MAGBOX" NOTE; it must be called exactly that and is case-sensitive. Click create.

			[[File:step21.jpg\|800px]]

			28. For "Subject" again enter " New Account Information MAGBOX" exactly like that. Change "Font Family" to "Courier New" This will make sure Alpha Numeric characters are show properly i.e l and L. Next paste the below test in and click save. NOTE you can edit this but take Note of the service fields such as {$service_username} etc. The {$service_domain} field is retrieved from the earlier module field "Domain URL"

			Dear {$client_name},


			Your order for {$service_product_name} has now been activated. Please keep this message for your records.


			Product Details are :

			Product/Service: {$service_product_name}

			Payment Method: {$service_payment_method}

			Amount: {$service_recurring_amount}

			Billing Cycle: {$service_billing_cycle}

			Next Due Date: {$service_next_due_date}


			Login Details

			Portal: {$service_domain}

			Your MAC is: {$service_username}

			Thanks for choosing us.

			{$signature}

			29. Proceed back to "Products and Services" and lets configure the "Welcome Emails" for your products. For "Trials" select "New Account Information".

			[[File:step22.jpg\|800px]]

			30. For Paid subscriptions make sure to set the "Welcome Email" to "NONE". When the product is setup it will look for the Template "New Account Information" and send that.

			[[File:step23.jpg\|500px]]

Admin: /* How to Configure */

2021-03-28T17:28:05Z

How to Configure

← Older revision		Revision as of 17:28, 28 March 2021
Line 78:		Line 78:


	16. Fill in the below information. make sure you add a / of the end of your url's. If you are setting up a trial and wish to select all trial products from the panel select "trial_username". Click save. Your Trial products will now show in the drop down boxes		16. Fill in the below information including your "Decryption_Key". make sure you add a / of the end of your url's. If you are setting up a trial and wish to select all trial products from the panel select "trial_username". Click save. Your Trial products will now show in the drop down boxes

	[[File:Streamcreed8.jpg\|800px]]		[[File:Streamcreed8.jpg\|800px]]
Line 92:		Line 92:
	20. Because this is a free trial we select "Automatically setup the product as soon as an order is placed" and click save.		20. Because this is a free trial we select "Automatically setup the product as soon as an order is placed" and click save.

	[[File:~~Xtreamui9~~.~~png~~\|800px]]		[[File:streamcreed9.jpg\|800px]]

	21. For Paid Subscriptions. We select "official_username" for "Line Type". We then select products from the drop down boxes. NOTE: in the previous tab where you added your prices they should match. i.e If you only set Monthly pricing then you will only setup Monthly here.		21. For Paid Subscriptions. We select "official_username" for "Line Type". We then select products from the drop down boxes. NOTE: in the previous tab where you added your prices they should match. i.e If you only set Monthly pricing then you will only setup Monthly here.

Admin: /* How to Configure */

2021-03-28T17:21:13Z

How to Configure

← Older revision		Revision as of 17:21, 28 March 2021
Line 80:		Line 80:
	16. Fill in the below information. make sure you add a / of the end of your url's. If you are setting up a trial and wish to select all trial products from the panel select "trial_username". Click save. Your Trial products will now show in the drop down boxes		16. Fill in the below information. make sure you add a / of the end of your url's. If you are setting up a trial and wish to select all trial products from the panel select "trial_username". Click save. Your Trial products will now show in the drop down boxes

	[[File:~~Xtreamui8~~.~~png~~\|800px]]		[[File:Streamcreed8.jpg\|800px]]

	17. Note for "trial_username" I have selected the contents of the "Trial_ID" drop down box. If its a trial you must select that drop down box.		17. Note for "trial_username" I have selected the contents of the "Trial_ID" drop down box. If its a trial you must select that drop down box.

Admin: /* How to Configure */

2021-03-28T17:15:08Z

How to Configure

← Older revision		Revision as of 17:15, 28 March 2021
Line 61:		Line 61:
	11. Click "Create a New Product".		11. Click "Create a New Product".

	[[File:~~Xtreamui7~~.~~png~~\|800px]]		[[File:streamcreed7.jpg\|800px]]

	12. Fill in the above information. Make sure you select "~~XtreamResell~~" as the module. Click Continue.		12. Fill in the above information. Make sure you select "xrstreamcreed" as the module. Click Continue.

	[[File:Step8.jpg\|800px]]		[[File:Step8.jpg\|800px]]

Admin at 17:10, 28 March 2021

2021-03-28T17:10:43Z

← Older revision		Revision as of 17:10, 28 March 2021
Line 52:		Line 52:

	[[File:Streamcreed6.jpg\|800px]]		[[File:Streamcreed6.jpg\|800px]]

			=== How to Configure ===

			9. In order to create and configure a product, go to 'System Settings' → 'Products/Services'.

			10. Click "Create New Group" and click save.

			11. Click "Create a New Product".

			[[File:Xtreamui7.png\|800px]]

			12. Fill in the above information. Make sure you select "XtreamResell" as the module. Click Continue.

			[[File:Step8.jpg\|800px]]

			13. Fill in product Description. You can leave Welcome email as the default. We will setup a Email template later and you can come back and change the Welcome Email. Click continue.

			[[File:Step9.jpg\|800px]]

			14. If the product is for a free trial you would use the above settings. "Auto Terminate/Fixed Term" is the number of days to auto terminate the product. If its a 24 hour trial you would set that to 1 and 2 for 48 hours. Leave that as 0 for Paid Subscriptions.

			[[File:step10.jpg\|800px]]

			15. For Paid subscriptions you would use something similar to the above. Select "Recurring". The customer would then receive Recurring invoices on a Monthly, Quarterly etc, etc period. Set your pricing. Make sure "Auto Terminate/Fixed Term" is set to 0. Click save changes.


			16. Fill in the below information. make sure you add a / of the end of your url's. If you are setting up a trial and wish to select all trial products from the panel select "trial_username". Click save. Your Trial products will now show in the drop down boxes

			[[File:Xtreamui8.png\|800px]]

			17. Note for "trial_username" I have selected the contents of the "Trial_ID" drop down box. If its a trial you must select that drop down box.

			[[File:step15.jpg\|800px]]

			19. If you don't want the user to choose their own username or password you can check these boxes. This will generate a "Numeric" username and password. We did this because people find it easier to read numbers then complex randomly generated alpha, numeric ones.

			[[File:step14.jpg\|800px]]

			20. Because this is a free trial we select "Automatically setup the product as soon as an order is placed" and click save.

			[[File:Xtreamui9.png\|800px]]

			21. For Paid Subscriptions. We select "official_username" for "Line Type". We then select products from the drop down boxes. NOTE: in the previous tab where you added your prices they should match. i.e If you only set Monthly pricing then you will only setup Monthly here.

			[[File:step17.jpg\|800px]]

			21. Because this is a paid subscription we set "Automatically setup the product as soon as the first payment is received". So once whmcs receives payment it will automatically setup the user.

			[[File:step18.jpg\|800px]]

			22. In the next tab "Custom Fields". in the field "Field Name" enter "Username" NOTE: Its starts with a capital U. If the line is for a mac you would enter "MAC" here. NOTE: All in capitals.(if you are setting up a mac in the previous step you would select "official_mac or trial_mac from the "line Type" drop down box.
			If you want the user to choose their own username you would check all three boxes. "Required Field" "Show on Order Form" "Show on Invoice".
			If you selected "Random Username" in the previous section you will only check. "Required Field" "Show on Invoice"
			If you want to use the password generated by XUI make sure in the previous section you have not checked "Random Username" and select "Required Field" "Show on Invoice" here.

			23. Click "save" your product has now been setup.