Operator

Change the Free-period settings (partial: fields left out keep their value). Needs a session signed in with two-factor authentication (403 details.mfaRequired) no older than 5 minutes, and a reason; audited with {before, after}

put/operator/trial-settings

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/operator/trial-settings
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Request body

mode'off' | 'dry_run' | 'on'
grandfatherDaysinteger
graceDaysinteger
retentionDaysinteger
pauseMode'never' | 'when_payments' | 'always'
siteCapAction'block_new' | 'end_trial'
usageAction'warn' | 'end_trial'
usageClear'month_start' | 'manual'
pauseWarningDaysinteger
noticesstring[]
showCountdownboolean
advertiseTrialboolean
pausedPageboolean
termsSectionboolean
notestring nullable
reasonstring required

required: shown in the audit log verbatim

requestIdstring

idempotency key: a retried request with the same id changes nothing and writes no second audit entry

Response

Saved

status'ok' required
replayboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.