Provider guides
Enhance: configuration and operations
Create Enhance customer organizations, subscriptions and websites, with suspension, termination, verified plan changes and status sync.
On this page
Status and workflow
The Enhance extension provisions hosting through the Enhance control panel API. For each Agovena service it creates a customer organization under your reseller organization, a subscription to the product plan and a website for the product domain. It supports suspension, unsuspension, termination, verified plan changes, plan listing, status synchronization and a customer panel.
Production-ready for the documented scope. Every operation under Supported operations is implemented against the official Enhance orchd OpenAPI specification (version 12.25.14) and verified with automated tests that replace the provider with faked HTTP responses, without network calls. Live acceptance on your own Enhance account remains an operator responsibility: create, suspend, unsuspend, change and terminate one disposable subscription on your own control panel before you sell it. Operations under Not supported are not advertised.
Requirements
- Agovena Core
^0.0.1. - The Provisioning Module, enabled before this extension.
- An Enhance control panel reachable over HTTPS.
- An access token with the Super Admin role and the Org ID of the reseller organization, both shown under Settings > Access Tokens in Enhance.
- Numeric plan IDs of the reseller organization.
Set up the package
- Enable the Provisioning Module, then install and enable Enhance in Admin > Extensions.
- In Enhance, open Settings > Access Tokens, create a token with the Super Admin role and note the token and the Org ID.
- Save
api_urlasscheme://host[:port]without a path, for examplehttps://cp.example.com, the access token inapi_tokenand the Org ID inaccount_id(Reseller organization id). The token is encrypted at rest. - Keep
verify_tlsenabled. - Run Test connection. It reads the reseller organization (read-only
getOrg). - On each provisionable product, set Plan id to a numeric plan ID of the reseller organization and Domain to the website domain.
Supported operations
Calls go to https://host:port/api/... with a bearer token. Listings are read page by page until all items were seen.
| Operation | operationId |
|---|---|
| Health check | getOrg on the reseller organization |
| List plans on create and plan change | getPlans |
| Create customer organization | createCustomer |
| Create subscription | createCustomerSubscription |
| Create website | createWebsite |
| Reconcile an interrupted subscription or website create, terminate check | getCustomerSubscriptions, getWebsites |
| Status sync, plan change verification | getSubscription |
| Suspend, unsuspend, plan change | updateSubscription |
| Terminate | deleteSubscription, soft delete without force |
| Remove the customer organization | deleteOrg, soft delete without force |
Status sync requires the subscription to belong to the recorded customer organization and your reseller; suspendedBy means suspended. A plan change is recorded only after getSubscription reports the new planId.
Not supported
- Customer logins, memberships and single sign-on. Customers get panel access through the merchant in Enhance.
- Power actions, capacity checks, dedicated server selection and forced deletion of data.
Failure handling and ownership
- Ownership is proven only by a row in
enhance_accounts, inserted before any create call. A domain already claimed on the same panel is refused without a provider call. Each create step records its returned ID under the revision check, and every lifecycle call holds a per-service lock outside database transactions. 400,404and409answers, refused credentials and errors before sending prove that nothing was created. The claim becomesfailedand a retry creates the missing steps. Timeouts, other errors and unexpected bodies leave the claimunknownand the service goes to manual review.- An interrupted customer organization create is never retried and needs manual review. An interrupted subscription or website create is retried only when the customer organization Agovena created has none at all. Nothing found by name is adopted.
- Status sync, suspension and plan changes require the claim state and current endpoint to match. A subscription that is deleted, held by another organization or sold by another vendor is refused for manual review.
- Terminate deletes only the recorded subscription, which also soft deletes its websites. The customer organization is deleted only when all its subscriptions and websites are deleted; otherwise it is kept and released from the claim.
- No passwords are generated or stored, and the access token never appears in claim rows, service meta, exceptions or panel data.
Configuration contract
| Field | Type | Required | Secret | Default |
|---|---|---|---|---|
api_url |
string |
Yes | No | Empty |
api_token |
string |
Yes | Yes | Empty |
account_id |
string |
Yes | No | Empty |
verify_tls |
boolean |
No | No | true |
timeout |
string |
No | No | "20" |
account_id is the Org ID of the reseller organization, not a customer organization. Calls never follow redirects, verify TLS, pin DNS through the shared provisioning HTTP client and are refused in the demo environment. Production refuses plain HTTP and unverified TLS. Store secret values only in the protected extension settings, never in product descriptions, URLs, screenshots or shared examples.