{"id":19716392,"url":"https://github.com/computestacks/billing-whmcs","last_synced_at":"2025-06-15T23:04:01.010Z","repository":{"id":152867845,"uuid":"116723307","full_name":"ComputeStacks/billing-whmcs","owner":"ComputeStacks","description":"WHMCS ComputeStacks Module","archived":false,"fork":false,"pushed_at":"2021-09-01T06:24:41.000Z","size":422,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-27T22:04:26.298Z","etag":null,"topics":["whmcs"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ComputeStacks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-08T20:16:13.000Z","updated_at":"2024-01-16T06:55:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"24b8891a-b8e7-4572-9a18-1f33c4ce62bb","html_url":"https://github.com/ComputeStacks/billing-whmcs","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ComputeStacks/billing-whmcs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fbilling-whmcs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fbilling-whmcs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fbilling-whmcs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fbilling-whmcs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ComputeStacks","download_url":"https://codeload.github.com/ComputeStacks/billing-whmcs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComputeStacks%2Fbilling-whmcs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260063246,"owners_count":22953513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["whmcs"],"created_at":"2024-11-11T22:41:56.764Z","updated_at":"2025-06-15T23:04:00.971Z","avatar_url":"https://github.com/ComputeStacks.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ComputeStacks WHMCS Plugin\n\n## Overview\n\nThe ComputeStacks integration for WHMCS provides an easy onboarding experience for your customers. It offers a customized ClientArea integration, along with seamless onboarding.\n\n* Each service in WHMCS corresponds to a single ComputeStacks account\n* ClientArea output for quick overview\n* Easy SingleSignOn buttons in both ClientArea and Admin\n* Support for charging an initial deposit on registration\n* Import CS accounts into WHMCS using the [Server Sync Tool](https://docs.whmcs.com/Server_Sync_Tool)\n\n### Service Terminations\n\nThis plugin will not delete any services in ComputeStacks. When a WHMCS service is terminated, this plugin suspends the account in ComputeStacks, which stops all running services. You will then need to manually delete the user. _If you wish to have WHMCS automatically delete the users in ComputeStacks, please contact your CS support team._\n\n## Installation\n\n_**Note:** We require WHMCS v8+_\n\nFor WHMCS versions before v8, please see [v2.0.0](https://github.com/ComputeStacks/billing-whmcs/releases/tag/v2.0.0).\n\n### Upload Files\nUpload the plugin to your WHMCS server and move the `whmcs/modules/servers/computestacks` directory to the corresponding directory within your WHMCS installation.\n\n\n### WHMCS Server\n\nCreate a new server and supply your ComputeStacks installation details.\n\n_**Note:** You will need to generate API Credentials using an admin user in ComputeStacks. The API Key in ComputeStacks corresponds to the username field in WHMCS, and the API Secret is the password._\n\n### WHMCS Product\n\nOur integration is designed to work in conjunction with our User Group functionality within ComputeStacks. This is useful if you decide to offer different tiers of service.\n\nTo create your ComputeStacks product, create a new product group and product with the settings:\n\n* Pricing:\n  * With Deposit: Choose OneTime fee and set your deposit amount\n  * Without Deposit: Choose Free\n* Module: ComputeStacks\n  * User Group: Your choice\n  * Apply Credit: If you added a one-time fee, you can optionally convert that to an account credit.\n    * _Note: This will take place at the moment the order is paid._\n  * Module Setup:\n    * With Account Credits, we recommend either:\n      * _**Automatically setup the product as soon as the first payment is received**_ (preferred for best user experience)\n      * _Automatically setup the product when you manually accept a pending order_\n    * Without Account Credits, we recommend either:\n      * _**Automatically setup the product as soon as an order is placed**_ (preferred for best user experience)\n      * _Automatically setup the product when you manually accept a pending order_\n\n## Configure ComputeStacks\n\nBefore we proceed, you will need to first [generate API credentials](https://docs.whmcs.com/API_Authentication_Credentials) for ComputeStacks. Here are the roles that we need assigned:\n\n* `Billing -\u003e AddBillableItem`\n* `Client -\u003e GetClients`\n* `Client -\u003e GetClientsDetails`\n* `Client -\u003e GetClientsProducts`\n* `Products -\u003e GetProducts`\n* `Products -\u003e UpdateClientProduct`\n* `Servers -\u003e GetHealthStatus`\n\n**WHMCS Access Control:** Please see the [documentation](https://developers.whmcs.com/api/access-control/). You can either allow the IP Address of ComputeStacks, or configure an Access Key.\n\nIn ComputeStacks, navigate to the `Administrator -\u003e Advanced Settings -\u003e Billing`.\n1. Edit `BILLING_MODULE` and set the value to `Whmcs` and click save. Once you do, additional settings will become available.\n2. Set both `WHMCS_API_SECRET` and `WHMCS_API_KEY`\n3. If you set an API Access Key in WHMCS, then you can enter that under `WHMCS_ACCESS_KEY`.\n\nWith WHMCS enabled, ComputeStacks will by default disable the registration form to ensure all new users come through WHMCS. Administrators can manually create users from within the admin.\n\nIf you wish to keep the registration form on, you can manually enable that under `Settings -\u003e Advanced Settings -\u003e General` and setting `SIGNUP_FORM` to `t`. Keep in mind that users will be able to register and will _not_ be charged for their usage unless you manually set their `external_id` to the ID of their WHMCS service.\n\nThe final step is to set your prices under `Settings -\u003e Billing Plans`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomputestacks%2Fbilling-whmcs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomputestacks%2Fbilling-whmcs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomputestacks%2Fbilling-whmcs/lists"}