Get storefront password-protection status

GET

https://numueg.app/api/v1/stores/{store_id}/settings/storefront-password

Last modified:2026-09-19 16:39:33

x-numu-scope:settings:read

Return whether the storefront is password-protected (never the hash).

Also reports the platform billing lock, which gates the storefront while
the tenant sits in read_only. That one is state rather than a switch:
only a top-up or a paid subscription clears it.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://numueg.app/api/v1/stores//settings/storefront-password' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "enabled": true,
        "has_password": true,
        "billing_locked": false,
        "billing_lock_reason": "string",
        "billing_lock_password": "string"
    },
    "message": "string"
}

Modified at 2026-09-19 16:39:33

Update COD Autopilot settings

Enable/disable storefront password & set the password