Admin Guide

Platform Settings

A small set of key–value settings that change behaviour for every business on the platform at once.

Last updated 2026-10-13

DigitalKey ERP — Docs · digital-key.co/docs/admin/settings

ImportantThese apply to every tenant. There is no per-business override — changing a grace period changes it for all customers immediately.
Admin — Platform settings
Platform settings
Platform settings — Settings grouped by area with their current values and labels.

The settings

GET /api/v1/admin/settings
ParameterTypeRequiredDescription
lifecycle_temp_suspend_daysinteger= 5OptionalDays a user stays in temp_suspend before dropping to suspend.
lifecycle_suspend_daysinteger= 5OptionalDays in suspend before deactivation.
lifecycle_warning_balanceinteger= 20000OptionalBalance in IQD below which a low-balance warning is raised.
platform_namestring= DigitalKey ERPOptionalPlatform name used in the interface.
billing_currencystring= IQDOptionalCurrency label for billing.

Changing a setting

PUT /api/v1/admin/settings/{key}
ParameterTypeRequiredDescription
keystringRequiredThe setting key. Taken from the URL.
valuestringRequiredThe new value, sent as a string.
NoteEvery value is stored as a string and converted when read. Numeric settings must still be sent as strings, and an unparseable value falls back to the built-in default rather than failing.

The grace periods

Together these two decide how long a customer has between a failed payment and a closed account. With the defaults that is ten days.

WarningChanges take effect on the nextdaily billing run and are measured against each user's status_changed_at. Shortening a grace period can therefore deactivate customers who are already part-way through one — check how many users are currently suspended before reducing either value.
TipLengthening is safe: users mid-grace simply get more time. If you need to give customers breathing room during a payment outage, raising these is the least disruptive lever available.

The warning threshold

lifecycle_warning_balance is the balance below which a user is considered low and warned. It does not stop anything happening — it is an early signal.

NoteThe default of 20,000 IQD suits a typical small subscription. If most of your customers pay considerably more than that each month, raise it so the warning arrives with enough notice to act on.

Related