Documentation / API Hosting Accounts, Packages and Plans / Hosting Account Lifecycle API Workflow

Hosting Account Lifecycle API Workflow

How a provider system should safely model future account provisioning through the API while using current read endpoints for verification.

How a provider system should safely model future account provisioning through the API while using current read endpoints for verification.

Coverage

ItemStatus
GET /api/v1/accounts.php is availableAvailable
Create, suspend, unsuspend, package change, and limit update endpoints are planned unless route files are addedUse deployed route documentation

Workflow

  1. Confirm each route against the deployed route documentation.
  2. Test with a staging token first.
  3. Use read endpoints to inspect current state before any write operation.
  4. Record the external workflow ID in your own system.
  5. Review jobs, request logs, and audit logs after the workflow runs.

Notes

  • Do not create production automation around undocumented routes.
  • Use idempotency keys for write endpoints.
  • Keep rollback steps documented with the integration runbook.

Diagram

flowchart TD
    A[External System] --> B[Read Current State]
    B --> C{Expected State?}
    C -- No --> D[Stop and Alert]
    C -- Yes --> E[Run Approved Workflow]
    E --> F[Read Jobs and Logs]
    F --> G[Operator Review]
← Accounts Endpoint Packages and Plans API Concepts →