---
title: "Store settings"
description: "Every page under a store's settings, from its name and address to webhooks."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Store settings

**Store settings** holds what applies to one store. Its sidebar has two sections:

- **Store**: **General**, **Plan & usage**, **Domain**, **Customer messages** and **Automations**.
- **Connections**: **Integrations**, **API clients**, **Webhooks** and **License keys**.

The sidebar shows only the pages your access lets you read. When you can read a page but not change it, a notice at the top says so and the controls stay disabled. What your business and team share across stores (members, payouts, billing) lives under the business instead: see [Business, team and account](/merchant-app/business-and-team).

## General

How customers find your store, how it looks, and what they keep after buying.

_Screenshot: The store's General settings: its name, address, ID and icon._

Edits to the fields wait for **Save** at the top of the page. **Discard** puts back what is saved. If someone else saved these settings after you opened them, saving opens **Settings changed elsewhere**: **Reload** shows what is saved now and drops your changes, **Overwrite** saves only the fields you changed over the latest settings.

### Store

How customers and the API find it.

| Row | What it shows |
| --- | --- |
| **Shown as** | The store's name with its icon. |
| **Address** | The address customers visit. |
| **Store ID** | The store's ID, with a button to copy it. You need it for the API. |

**Store icon** takes a PNG, JPEG, WebP or GIF image of up to 10 MB. Drop it on the field or use **Choose image**. It replaces the icon at once, without **Save**.

### Details

| Field | What it does |
| --- | --- |
| **Name** | What customers and your team see your store called. Required, up to 120 characters. Spaces at either end are dropped, and a name that shows nothing is refused. |
| **Description** | Optional. Shown to search engines and when your store's link is shared. Up to 2,000 characters. |
| **Language** | New customer messages start in it, and your storefront uses it for its own text. |
| **Currency** | The overview opens in it, and currency menus offer it first. You can also pick **No currency**. |

### Colors

Your store's buttons and links take these colors, and so do the links in the emails your customers get. Leave one empty for the default.

- **Accent color**: used on a light background.
- **Accent color in dark mode**: for visitors whose device is in dark mode.

Enter a hex color such as `#f59e0b`, or pick one.

### Orders and access

What happens to what customers bought.

- **Delivery links last**: how long a link to a delivered file works, in minutes, from 1 minute to 10,080 minutes (7 days). See [Files and storage](/merchant-app/storage).
- **Remove access to what a refunded order unlocked**: when on, refunding an order also takes away the access it gave. See [Orders and subscriptions](/merchant-app/orders-and-subscriptions).

### Sherpo address

Where customers find your store on Sherpo. **Change address** opens a dialog for the new address: 6 to 63 characters, lowercase letters, digits and hyphens, starting and ending with a letter or digit. An address another store has, or one Sherpo keeps for itself, is refused.

> **Changing the address moves your links**
>
> Your store's links move to the new address. Links to the old address keep reaching your store until you change the address again, then they stop working, so update the links you've shared. Apps that customers connected through the old address ask them to connect again once it stops working. After that, the old address stays held for your store for 90 days, so you can switch back to it and no other store can take it.

The address change saves on its own, without **Save**. It waits while a save of the form is running.

### Close the store

**Delete store** deletes the store with its products. Its address stops working and customers can no longer open what they bought. This can't be undone. Only a member with full access can delete a store.

Deleting a store doesn't change what your plan bills: it keeps paying for the same number of stores. To pay for fewer, use **Remove a store** in [Billing](/merchant-app/business-and-team#billing). See [What each plan allows](/merchant-app/plans#changing-plan).

1. Select **Delete store**.
2. Confirm in the dialog. Sherpo emails a code to your address.
3. Enter the 6-digit code and confirm. If it doesn't arrive, **Send a new code** works a minute after the last one, and only a few times a day.

## Plan & usage

What this store's plan includes and how much of it the store uses. The business's plan sets these limits for each of its stores; you change it from **Billing**. The **Upgrade** button takes you there on Lite, and **Choose a plan** with no plan. Pro and Sherpo One have none, as Sherpo One is arranged with Sherpo, and neither does a plan set up with Sherpo. Where there is one, a member who doesn't manage billing is asked to contact one who does.

_Screenshot: Plan \& usage: the business's plan, what the store uses of its storage and transcription, and its limits._

- **Plan**: the plan's name, and whether it renews, ends or moves to another plan on a date.
- **Usage**: what the store holds and uses against its allowances.
  - **Storage**: what the store's files use of its allowance, the plan's plus its own blocks.
  - **AI media minutes**: minutes used of the month's allowance, the plan's plus its own blocks, with the day it renews.
- **Limits**: how many of each the store can have.
  - **Customers**: the count against the plan's limit, or "no limit".
  - **Pages**, **Menu items**, **Redirects within the store** and **Redirects to other sites**.
- **Add-ons** (Pro): the store's blocks of storage and AI media minutes, which add to its allowance and no other store's. Every member sees them; only a member with full access adds or lowers them. During the free trial, a member with full access can end the trial and pay now to add them. See [Add-ons](/merchant-app/plans#add-ons).
- **Features**: what the plan turns on, each **Included** or **Not included**: **Your own domain**, **White-label, no Sherpo branding**, **Custom stylesheet**, **Quizzes and certificates**, **Sherpo in your own codebase** and **AI for media**.

Each row is tagged **Near limit** (from 90% of the customer limit, 80% of the others), **At limit**, **Over limit** or **Some inactive**, and a notice at the top names the most pressing one. Pages, menu items and redirects past what the plan applies stay inactive instead of putting the store over. See [What each plan allows](/merchant-app/plans) for every limit and what happens past one.

## Domain

Serve your store on a domain you own, like `www.example.com`. It comes with Pro and Sherpo One; on another plan the page says so and, for a member who manages billing, links to **Billing** to upgrade. A store has one domain at a time, and its Sherpo address keeps working beside it.

1. Enter the domain and click **Connect**. A subdomain like `www` works with every DNS provider; a bare domain like `example.com` needs a provider that supports CNAME flattening or ALIAS records. A Sherpo address, or a domain another store uses, is refused.
2. At your domain's DNS provider, add the records the page lists: a **CNAME** from your domain to the target shown, and, while it's listed, a **TXT** record that proves the domain is yours. Each value has a copy button.
3. The domain shows **Waiting for DNS** until the records are in place, usually within an hour. Sherpo checks it every few minutes; **Check now** checks at once.

Once it shows **Live**, your store answers on the domain with its own certificate, and it becomes the store's main address: links, search engines and your Sherpo address all lead to it.

If the domain doesn't go live within 14 days, it's let go and shows **Not connected**: fix the records, click **Dismiss**, and connect it again. A live domain that stops pointing at your store also shows **Not connected**, and your Sherpo address is the main one again until it serves once more.

If your business moves to a plan without your own domain, a live domain keeps working and stays on the page, with a note about the plan beside it. A domain that never went live stays **Waiting for DNS** and doesn't become the store's main address until the plan includes a domain again; it's let go after 14 days like any other.

**Remove** takes the domain off: your store stops answering on it, and your Sherpo address becomes its main address again. Connecting and removing a domain needs permission to edit the store's site; a member who only reads it sees the domain and its records.

## Customer messages

What your store sends customers, and when. Each email wears your store: its icon, its name and its colors. The list shows one row per message, with **When** (the event), **Sends for**, **Language** and a **Sending** switch.

Emails a customer could otherwise get again and again wait 2 minutes, so a burst sends one, and each has a daily cap; past it, what happened still happens, but no email goes:

| Email | At most, in any 24 hours |
| --- | --- |
| A subscription canceled or reactivated | 8 per subscription, 20 per customer |
| A refund | 3 per order, 10 per customer |
| A discount from an automation | 3 per product, 10 per customer, listing at most 8 codes |
| Access from an automation | 3 per product, 20 per customer |
| A private feed's new address, or its turning off | 4 per product, 10 per customer |
| A new license key | 5 per license, 15 per customer |

None of these emails shows a product's subtitle, and a refund email shows its reason only when it is one the payment processor names (such as a duplicate charge), never one you wrote. A member invite names its sender by their email address.

### Events

| Event | Sent when |
| --- | --- |
| **Access granted** | A customer gets access to a product. |
| **Request received** | A buyer's get of a product that requires approval waits for you. |
| **Added to the waitlist** | A guest joins a full event's waitlist. |
| **Request approved** | You approve a request, or let a guest in from the waitlist. |
| **Request declined** | You decline a request or a waitlist place. |
| **Request released** | A paid request's card hold was released a day before it lapsed, as you hadn't decided it. |
| **Request payment due** | The charge of a paid request you approved, or a guest you let in, failed or found no saved card, so they're asked to pay. |
| **Discount unlocked** | A customer unlocks a discount. |
| **Refund processed** | A refund goes through. |
| **Affiliate commission earned** | An affiliate earns a commission. |
| **Subscription started** | A subscription starts. |
| **Subscription renewed** | A subscription renews. |
| **Renewal reminder** | A paid period is about to renew, 3 days before. |
| **Plan changed** | A subscription moves to another price. |
| **Payment failed** | A subscription's payment fails. |
| **Payment past due** | A subscription's payment is past due. |
| **Subscription unpaid** | A subscription stays unpaid. |
| **Subscription canceled** | A subscription is canceled. |
| **Subscription reactivated** | A canceled subscription is resumed. |
| **Event registration** | A customer gets a ticket to an event with a session ahead, by buying it, through a membership or from you, or comes back after their ticket lapsed. It lists the sessions ahead, shows their ticket's QR code for the door, and carries a calendar file. Someone whose ticket came before the event had a session ahead gets their QR code in each **Event changed** email instead, until a registration email reaches them. While it sends, the **Access granted** email leaves the event out. |
| **Event changed** | A session ahead is added, moved, given another place or taken off the schedule, or the event's location changes. It goes to everyone going a few minutes after your last edit, so a run of edits sends one email, with the schedule as it stands and a calendar file that updates theirs. Once a canceled event has a session ahead again, it also names the sessions the cancellation took off. |
| **Event canceled** | The last session ahead is taken off an event's schedule, or you cancel the event. It goes to everyone going, listing the sessions taken off, with a calendar file that takes them off their calendar. When you cancel the event, it also tells them their ticket ended and what is refunded to them. |
| **Event canceled for a buyer** | You cancel an event that a buyer bought tickets for and holds none of, having named a guest for each. It goes once to that buyer, naming their guests and saying how their money comes back. |
| **Event refund failed** | A refund of a canceled event fails at Stripe after the buyer's cancellation email said it was on its way. It goes once per refund to the buyer, saying it couldn't go through and that you'll refund them directly. Retrying a refund that fails again sends nothing more. |

The email telling a customer you [revoked their access](/merchant-app/orders-and-subscriptions#revoke-access) for cause isn't listed here: it always goes, at once, with your message and any refund, and can't be turned off. A customer gets at most 5 of them in any 24 hours.

Reminders a day and an hour before each session, and a thanks an hour after an event's last session, go to the people going as browser notifications, never as emails; each customer turns them off in their own notification settings (see [Notifications](/customer-api/notifications)).

### Creating a message

**New message** opens a form:

- **When**: the event it sends on.
- **Sends for**: **All products**, or one product. A message for a product takes precedence over the one for all products.
- **Language**: Italian, English, English (United Kingdom), German, French, Spanish, Portuguese (Brazil) or Dutch. Customers get the one in their language, else the store's.
- **Send this message**: whether it sends.

There can be only one message for each event, product and language. Editing a message changes only whether it sends: its event, products and language stay, so add another message to change them.

### Defaults and deleting

Your store comes with default messages. They stay: you can't delete them, but you can turn their **Sending** off to stop them. Deleting a message you added leaves a broader message (for all products) to decide whether that event sends.

## Automations

Unlock products or lower prices when customers buy, review or check in at an event. The list shows each automation's name, **When**, **Then** and **Status** (**Active**, **Paused** or **Ended**).

### Creating an automation

**New automation** opens a form with a **Name** (optional; without one, the list describes the rule) and two parts.

**When someone**:

- **Buys** a **Bought product**, optionally **At price** (one of its prices, or **Any price**) and **With discount** (a discount that reaches what's bought, or **With or without one**).
- **Reviews** a **Reviewed product**, optionally with a **Rating** of at least 2, 3, 4 or 5 stars, or **Any rating**.
- **Checks in** at an **Event** (only events are offered), at one of its sessions picked in **Session**, or at **Any session**. It runs once for each customer, on their first check-in that counts.

A check-in undone before the automation runs skips it, and one undone after keeps what it unlocked or lowered.

**Then**:

- **Unlock a product**: pick the **Product to unlock**. The customer gets it as if they bought it.
- **Lower a price**: pick the **Product** and its **Price**, then an **Amount off**, a **Percent off** (0 to 100), or both. With both, the amount comes off first. The amount can't be more than the price. A free price can only take a percent. **Starts** (empty starts right away) and **Ends** (empty keeps it with no end) set the date and time it applies from and until, in the store's time zone.

Unlocking a product needs access to edit customers; lowering a price needs access to edit discounts.

### Managing automations

From a row's actions you can **Edit**, **Pause** or **Resume**, **View runs** and **Delete**. Deleting an automation keeps what it already unlocked or lowered with the customers who got it.

**View runs** lists what the automation did each time it fired: **Waiting**, **Done** (**Unlocked the product** or **Lowered the price**), **Skipped** or **Failed**, with the reason, such as "They already had it", "Its end had passed" or "New unlocks were paused: the store is past its plan's customer limit".

## Integrations

Services your store shares its data with. The list shows each integration Sherpo supports, with its logo, its **Kind**, its **Status** (**On**, **Needs setup** or **Off**) and a switch to share store data with it.

**Configure** opens its settings: the fields that service needs, such as an ID or a token. Secret fields never show their saved value: leave one blank to keep it, or use **Clear** to remove it on save. While nothing is saved for an integration that is off, fields with a usual value, such as an event name, start filled in with it. An integration can be turned on only once its required fields are set. Turn it off to stop sharing at any time.

To send your store's events to your own endpoint, add a [webhook endpoint](#webhooks) instead.

An integration that sets cookies in your visitors' browsers, such as Google Analytics, says so in its settings. Once it's on, your store shows a cookie banner to visitors where the law asks for consent, and loads its tags only after a visitor accepts; visitors can change their choice from **Cookie preferences** in the store's **Legal** menu or on its privacy policy. Turning one on from the list opens its settings first, so you see this before saving. Your store's own [customer analytics](/overview/analytics) is first-party audience measurement that sets no cookie, so the store shows no banner for it.

Turning on an integration that shares buyer and order data, or changing where it sends it, needs access to that data too.

While Sherpo fixes an integration, the list leaves it out: it shares nothing and can't be changed meanwhile. Its settings are kept, and it comes back as you left it.

If an app you connected set up an integration and the app is disconnected, its access expires or it loses the access the integration needs, the integration is turned off. Enter its secrets again before you turn it back on.

## API clients

Apps that sign your customers in and use the store for them, and keys your site reads the store with. They use the [customer API](/customer-api).

> **Pro and Sherpo One**
>
> Creating API clients needs a plan with **Sherpo in your own codebase**. On Lite, or with no plan, this store's own front-end can't use the customer API. See [What each plan allows](/merchant-app/plans).

### Kinds

**New client** asks for a **Kind**:

- **Client with a secret**: an app or a server that signs customers in and calls the store for them. Keep its secret on your server.
- **Publishable key**: lets your site's front-end read products and prices. It's public, so it can only read.

| Field | Client with a secret | Publishable key |
| --- | --- | --- |
| **Name** | Required, up to 120 characters. | Required, up to 120 characters. |
| **Customers let it** | What customers allow the app to do (at least one): **Read** (products, prices and what customers own), **Profiles**, **Email addresses**, **Checkout**, **Reviews**, **Quizzes**, **Progress** and **Subscriptions**. | Not asked. |
| **Redirect URIs** | Where customers return after signing in, one per line. | Not asked. |
| **Allowed origins** | Sites that may call the store from a browser, one per line. | Your site's address, one per line. Without one, only the store's own site can use the key. |
| **Rate limit** | Calls a minute. Empty uses the store's default. | **Rate limit per visitor**: each visitor gets this many. |
| **Quota** and **Quota period** | Calls **Per day** or **Per month**. Empty is no quota. | **Quota for every visitor together**: every visitor counts toward it. |

Redirect URIs and origins take up to 20 lines each, each under 2,048 characters, using `https://` (or `http://localhost` while testing).

A client with a secret can also **Signs in your own customers**: your site's backend gets a customer token with the client secret, for customers your site signed in, without Sherpo's sign-in. Anyone with the secret can act as any of your customers, so keep it on your server. Turning it on needs permission to edit customers, and turning it off ends every token it got this way.

### Secrets and keys

Creating a client with a secret shows its **Client secret** once: copy it then, as you won't see it again. A publishable key stays visible on its row, with its **Client ID**.

**Rotate secret** makes a new secret. **Old secrets keep working** sets how long the old ones last, so you can deploy the new one everywhere: **Stop right away**, **For an hour**, **For a day**, **For 7 days** or **For 30 days**. You can also revoke a single secret from the client's list of secrets.

**Revoke client** stops it at once, with every secret. This can't be undone.

### Apps that registered themselves

Apps your customers connect register here on their own, with no secret. One that no customer connects goes away after a while. **Verify app** vouches for an app you trust: it can pay with your customers' saved cards, remove them, set refund waivers and resume or change subscriptions, its consent page shows no unverified warning, and it stays even if no customer connects it. Verifying needs permission to edit customers. Revoke one to disconnect it for everyone.

## Webhooks

Endpoints your store sends events to as they happen, each signed with the endpoint's secret. Webhooks are on every plan. For the events' payloads, see the [merchant API](/merchant-api).

### Adding an endpoint

**Add endpoint** asks for:

- **Endpoint URL**: an `https` address on a public host, up to 2,048 characters. Redirects aren't followed. Private or local addresses, IP addresses, credentials and the part after `#` are refused.
- **Description**: optional, up to 500 characters, to tell endpoints apart.
- **Events**: at least one. Events that carry data your access doesn't let you read can't be chosen.
- **Send events to this endpoint**: whether it sends.

A store holds at most 20 endpoints.

### Events

Every customer message event above can go to a webhook, and these too:

| Event | Sent when |
| --- | --- |
| **Order created** | An order is placed. |
| **Order refunded** | An order is refunded. |
| **Review posted** | A customer posts a review. |
| **Access revoked** | A customer's access is taken away. |
| **Access revoked for cause** | You revoke a customer's access for cause, from an order or a grant. |
| **Certificate issued** | A customer is issued a certificate. |
| **License issued** | A customer is issued their license to a software product, once, when they first get access. |
| **License disabled** | A license is turned off, so it no longer checks as valid. |
| **License enabled** | A disabled license is turned back on. |
| **License replaced** | A license gets a fresh key, rotated by you or by the customer, and the old key stops working. |
| **License activated** | A license counts a new device, or a freed or inactive one comes back. |
| **License deactivated** | A device is freed from a license, by the customer, by you or by your software. Replacing a key frees its devices without this event. |
| **License activation limit reached** | A device was refused because the license holds its limit; at most once an hour per license. |
| **Customer created** | A customer joins the store. |

### Signing secret

Adding an endpoint shows its **Signing secret** once: copy it then, as you won't see it again. Check each delivery's `Sherpo-Signature` header, `t=<seconds>,v1=<signature>`, where the signature is the hex HMAC-SHA256 of the seconds, a dot and the body, keyed with this secret.

```js
import { createHmac, timingSafeEqual } from 'node:crypto';

// Checks a delivery's Sherpo-Signature header against the raw body, refusing ones signed over 5 minutes ago.
const isSigned = (header, body, secret, toleranceS = 300) => {
  const parts = Object.fromEntries(header.split(',').map((p) => p.split('=')));
  const signedAt = Number(parts.t);
  if (!Number.isFinite(signedAt) || Math.abs(Date.now() / 1000 - signedAt) > toleranceS) return false;
  const expected = createHmac('sha256', secret)
    .update(`${parts.t}.${body}`)
    .digest('hex');
  const given = Buffer.from(parts.v1 ?? '');
  return given.length === expected.length && timingSafeEqual(Buffer.from(expected), given);
};
```

Each attempt is signed as it's sent, so a tolerance of a few minutes refuses an old delivery replayed later. The `Sherpo-Event-Id` header names the event and stays the same across attempts and resends, so skip one you already handled. `Sherpo-Event-Type` names its type.

**Roll secret** makes a new one that signs every delivery from then on; the old one stops at once, so the endpoint rejects deliveries until it has the new secret.

### Deliveries

**Deliveries** lists the latest events sent to an endpoint, newest first, each **Pending**, **Delivered** or **Failed**, with its attempts, the last answer and the last error. **Failed only** shows the ones that failed.

A delivery counts as delivered when your endpoint answers with a 2xx status within 5 seconds. Any other answer, a host that can't be reached or no answer in time is a failed attempt, and the next one follows 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and 24 hours later. After the last, the delivery is **Failed**. A delivery also fails at once, without retries, when your endpoint answers with a redirect, when its host resolves to an address webhooks can't reach (such as a private or local one), when the endpoint is turned off, or when the app that set it up is disconnected. Fix the cause, then **Resend** it: **Resend** works on a delivered or failed delivery while the endpoint is on, and on a waiting one that says **Nothing is sending it any more.** It never resends a delivery whose event was undone since, which is a refund the payment provider later failed, a certificate that was revoked or taken back by an undone check-in, or a license dropped because the customer who accepted an invite already held one. Such a delivery still waiting isn't sent: it shows **Failed** if it was already tried or resent, and otherwise leaves the list. For an endpoint whose app was disconnected, turn **Sending** back on first, which makes the endpoint yours.

Deleting an endpoint stops its events at once and removes its delivery history. To pause it instead, turn **Sending** off: events that happen while it's off aren't sent later, and deliveries still waiting fail.

If an app you connected set up an endpoint and the app is disconnected, its access expires or it loses the access its events need, the endpoint is turned off. Check its URL and roll its secret before you turn it back on.

## License keys

The public keys your software checks offline license tokens against. When your server activates a device or refreshes its token through the [merchant API](/merchant-api/guides/verify-licenses-offline), it gets a token signed with your store's key, and your software checks it with no network. You need to read customers to see this page, and to change them to create or rotate keys.

_Screenshot: License keys: the key set to embed, then the current, next and previous keys with their public keys._

- **Key set**: the keys to embed in your software, with a copy button. Embed the whole set, and update it in each release.
- **Keys**: each key's id and public key, and its status. **Current** signs new tokens; **Next** signs them after the next rotation, so software that embeds it keeps working through one; **Previous** signs nothing more, and stays in the set until the date shown, so tokens it signed still verify.

Your store gets its keys when a device first activates, or with **Create keys** before then.

**Rotate keys** makes the next key sign and adds a new next key. Ship the new set before you rotate again. If a key may have leaked, tick **Retire previous keys now**: every key that no longer signs leaves the published set at once, so a set fetched from then on refuses tokens they signed. Software that embeds the set keeps trusting the retired keys until you ship an update without them.

Source: https://docs.sherpo.io/merchant-app/settings/index.mdx
