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

# Leat Loyalty Points

> Control how storekit customers earn Leat points: what counts towards the total, the opt-in box, the earn message, sign-up and where rewards are shown.

Once **Enable Leat** is on, storekit sends every accepted order from a signed-in customer to Leat, and Leat works out the points from your own earning rules. This page covers the storekit-side settings that shape that: what the order total includes, whether customers have to opt in, and what they see.

All settings are on **Stores** → your store → **Settings** → **Integrations** → **Leat**. Click **Save** in the top bar.

## How Points Are Earned

1. The customer signs in on your ordering page (or gives their email at checkout).
2. At checkout storekit asks Leat what the basket would earn and shows *You'll earn 12 points on this order*.
3. When you **accept** the order, storekit records it against the customer's Leat contact and the shop chosen under **Rewards at checkout** → **Edit** → **Shops**. Leat then applies its earning rules and updates the balance.
4. If the customer has no Leat contact yet, one is created from their email address.

Orders placed as a guest with no email address earn nothing. Points are awarded on accepted orders only — a rejected or failed order is never sent.

<Note>
  Pay at Table bill payments do not earn points in storekit: the bill page can show the opt-in box and an earn estimate, but nothing is recorded in Leat when the bill is paid. Rewards, vouchers and gift cards can still be used on a bill — see [Rewards and Vouchers](/docs/guides/integrations/loyalty/leat/rewards-and-vouchers#pay-at-table) and [Gift Cards](/docs/guides/integrations/loyalty/leat/gift-cards).
</Note>

## What Counts Towards the Total

Points are earned on the amount the customer actually pays — the order total after any discounts, rewards and vouchers. Two toggles decide how that total is read when points are later reversed on a partial refund:

Open **Rewards at checkout** → **Edit** → **Show advanced** to find **Include delivery costs** and **Include service charges**.

| Setting | Effect |
| - | - |
| **Include delivery costs** | Treat the delivery fee as part of the value the points were earned on |
| **Include service charges** | Treat service charges as part of the value the points were earned on |

With a toggle off, that part of the order is left out when storekit works out what share of the points a partial refund should take back. See [Reversing points](#reversing-points).

### Use Orders API

**Use Orders API** is in **Gift cards & orders** → **Edit**. With it on, storekit sends Leat the full order — each line, quantity and price — instead of just the total. Turn it on if you use Leat rules that depend on what was bought (product-based earning, product-specific promotions or Leat's own order reporting). If you only need points from the amount spent, leave it off.

### Credit Unit Name

**Credit unit name** is in **Rewards at checkout** → **Edit**. It is the name of your points unit in Leat — for example `points` or `stamps`. It must match a unit that exists in your Leat account; storekit checks this and falls back to your Leat default unit if the name is not recognised. The name is also the word customers see in *You'll earn 12 points on this order*.

## Loyalty Opt-In

Some operators want customers to choose to join the programme rather than earn silently. Open **Sign-up & opt-in** → **Edit** to configure these options.

| Setting | Effect |
| - | - |
| **Enable loyalty opt-in** | Shows a tick box at checkout to customers who are not signed in to Leat. Their order only earns points if they tick it. Customers already signed in are opted in automatically and see no box. Off means every order with an email earns |
| **Loyalty pre-select** | The box starts ticked |
| **Loyalty label** | The text next to the box, for example *Earn points on this order* |

The opt-in only controls earning. Customers can still redeem rewards, use vouchers and pay with gift cards regardless of the box.

## Sign-Up Through storekit

With **Enable user register** on in **Sign-up & opt-in** → **Edit**, customers who do not yet have a Leat account can create one from your ordering page. They enter their email address, receive a verification code and are signed in with a new Leat contact. Turn it off to limit sign-in to customers who already exist in Leat.

## Rewards Visibility

These toggles decide where signed-in customers see the rewards they have earned. Find **Show rewards** and **Show inline rewards in basket** in **Rewards at checkout** → **Edit**. Find **Show rewards popup after login** and **Skip popup when guest has no rewards** in **Sign-up & opt-in** → **Edit** → **Show advanced**. Find **Enable rewards on Pay at Table** in **Gift cards & orders** → **Edit** → **Show advanced**. How the rewards themselves are set up is covered in [Rewards and Vouchers](/docs/guides/integrations/loyalty/leat/rewards-and-vouchers).

| Setting | Effect |
| - | - |
| **Show rewards** | Adds **View rewards** to the ordering page so customers can browse and redeem rewards and vouchers (unless **Enable rewards on Pay at Table** is on, which moves them to the bill). Off hides rewards entirely |
| **Show inline rewards in basket** | Also lists the rewards the customer can currently afford inside the basket, with a **Redeem** button on each |
| **Show rewards popup after login** | Opens the rewards list automatically when a customer signs in |
| **Skip popup when guest has no rewards** | Only show that popup when there is something to redeem |
| **Enable rewards on Pay at Table** | Hides rewards and vouchers from the basket — customers redeem them on the bill instead |

## Earn Message

The earn message is the *You'll earn 12 points on this order* line in the basket and at checkout, and *You earned 12 points on this order* on the order summary. Open **Earn message** → **Edit** to hide it. Select **Show advanced** to customise its text, icon, colour or font, or preview your changes:

| Setting | Effect |
| - | - |
| **Hide earn message completely** | The message is never shown. Points are still earned |
| **Customise earn message** | Unlocks the styling controls below and uses them instead of your storefront's default styling |
| **Earn message text** | Your own wording. Use `{value}` for the number and `{creditName}` for the unit name; leave blank for the default text |
| **Icon** | An optional icon shown before the text — a square PNG or SVG, 64×64 recommended |
| **Text colour**, **Background colour**, **Opacity**, **Font** | Colours and type for the message pill. **Preview** shows the result as you edit |

## Reversing Points

The order's customer card in the dashboard shows the credits **Earned** on that order. You can take them back in two places:

* **When refunding** — the refund dialog shows a **Loyalty** tick box (*Revoke loyalty points for this transaction*), ticked by default. A full refund reverses all the points; a partial refund reverses the same share of the points as the share of the order refunded.
* **Without a refund** — click **Reverse** next to **Earned** on the customer card to deduct every point the order earned.

Either way the deduction is posted to the customer's Leat balance straight away and the **Earned** figure on the order drops to what is left.

## Next Steps

<CardGroup cols={2}>
  <Card title="Rewards and Vouchers" icon="ticket" href="/docs/guides/integrations/loyalty/leat/rewards-and-vouchers">
    Give customers something to spend their points on
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/docs/guides/integrations/loyalty/leat/troubleshooting">
    Points not arriving or the wrong amount
  </Card>
</CardGroup>


## Related topics

- [Troubleshooting Leat](/docs/guides/integrations/loyalty/leat/troubleshooting.md)
- [Leat Overview](/docs/guides/integrations/loyalty/leat/overview.md)
- [Connecting Leat](/docs/guides/integrations/loyalty/leat/connect.md)
- [Loyalty Programs](/docs/guides/increasing-sales/loyalty-programs.md)
- [Leat Rewards and Vouchers](/docs/guides/integrations/loyalty/leat/rewards-and-vouchers.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.