Appearance
Skip to content
Are you an LLM? You can read better optimized documentation at /tenants/integration/activation.md for this page in Markdown format
Tenant Activation
Tenant Activation lets you enable or disable a tenant as a whole, without deleting it. Disabling is a safe, reversible "off switch" for suspending a brand while preserving all of its history.
Permissions
| Action | Permission required |
|---|---|
| Enable or disable a tenant | tenant:manage:activation |
What disabling does
When a tenant is disabled:
- Its checkout stops. Public checkout requests on the tenant's domains are rejected with a Not Found (404) response — to the public, the storefront simply no longer exists.
- Its API credentials stop working. Any API request authenticated as this tenant is rejected with a Not Found (404) response.
- No new payments can be processed for it.
Existing records — the tenant itself, its configuration, its customers, and its payment history — are all preserved. Re-enabling the tenant restores it to service exactly as it was.
WARNING
Disabling a tenant takes its storefront offline for all of its customers. Use it to suspend a brand intentionally, not to make routine configuration changes.
TIP
The checkout block is served from a cache that refreshes about once a minute, so disabling (or re-enabling) a tenant can take up to a minute to take effect for public checkout. API credentials are rejected immediately.
Changing the activation state
The page shows a single switch reflecting the tenant's current state — Enabled or Disabled. Toggle the switch to the desired state and click Save.
When you disable a tenant, a confirmation dialog appears first, summarising the effect. The change is only applied after you confirm and save.
Toolbar actions
| Action | Color | Description |
|---|---|---|
| Refresh | Blue | Reloads the current activation state from the server |
| Save | Blue | Applies the selected activation state |