---
title: "Get company loyalty settings"
method: GET
path: "/settings"
tags: ["Settings"]
---

# Get company loyalty settings

`GET /settings`

Retrieves your company's current loyalty program configuration, including discount policy,
membership tier structure, referral reward rates, and operational limits.

**When to use:** Call this endpoint when initializing your application or periodically
(e.g., daily) to cache current settings. Settings rarely change but affect all transaction calculations.

Marketing settings can be configured in [UDS Admin](https://admin.uds.app/admin/marketing/discount).

## Headers

- `X-Origin-Request-Id` string, required
- `X-Timestamp` string, date-time, required

## Response `200`

Settings

- CompanySettings — Company loyalty program configuration. Contains discount policies, membership tiers, reward rates, and operational settings. Retrieved via GET /settings.
  - `id` integer, required — Company ID.
  - `name` string, required — Company name.
  - `promoCode` string, required — Company invitation promo code. Customers can use this code to join your loyalty program.
  - `currency` string, nullable, required — ISO-4217
  - `baseDiscountPolicy` 'APPLY_DISCOUNT' | 'CHARGE_SCORES', required — Defines loyalty program type: * `APPLY_DISCOUNT` — apply a discount to an order; * `CHARGE_SCORES` base discount won't apply but customer will receive points award with the same base discount rate applied to `cash` part of purchase operation.
  - `loyaltyProgramSettings` LoyaltyProgramSettings — Loyalty program settings defining membership tiers, reward rates, and referral bonuses. Configured in [UDS Admin](https://admin.uds.app/admin/marketing/discount).
    - `baseMembershipTier` MembershipTier, required — Membership tier (loyalty level) configuration. Defines the discount/cashback rate and automatic upgrade conditions based on spending or referral count.
      - `uid` string — Tier ID.
      - `name` string, required — Tier name.
      - `rate` number, required — Tier rate.
      - `maxScoresDiscount` number, nullable — The maximum discount (in percentage) allowed when redeeming points.
      - `conditions` object — Conditions to upgrade customer tiers automatically.
        - `totalCashSpent` object, nullable — Upgrade to tier when customer reaches target `cashSpent`.
          - `target` number — Amount of cash spent.
        - `effectiveInvitedCount` object, nullable — Upgrade to tier when customer reaches target `effectiveInvitedCount`.
          - `target` integer — Amount of invited count.
    - `membershipTiers` MembershipTier[], required — Status settings.
      - `uid` string — Tier ID.
      - `name` string, required — Tier name.
      - `rate` number, required — Tier rate.
      - `maxScoresDiscount` number, nullable — The maximum discount (in percentage) allowed when redeeming points.
      - `conditions` object — Conditions to upgrade customer tiers automatically.
        - `totalCashSpent` object, nullable — Upgrade to tier when customer reaches target `cashSpent`.
          - `target` number — Amount of cash spent.
        - `effectiveInvitedCount` object, nullable — Upgrade to tier when customer reaches target `effectiveInvitedCount`.
          - `target` integer — Amount of invited count.
    - `referralCashbackRates` number[], required — Rewards for referrals (3 levels)
    - `cashierAward` number, nullable, required — Cashier’s reward rate for the performed transaction.
    - `referralReward` number, nullable, required — Customer’s reward for an effective recommendation.
    - `receiptLimit` number, nullable, required — Maximum transaction amount that can be made through UDS Cashier.
    - `deferPointsForDays` number, nullable, required — Number of days before earned cashback points become available in the customer's balance. A value of 0 means points are available immediately.
    - `firstPurchasePoints` number, nullable — Number of points for the first purchase
  - `purchaseByPhone` boolean, required — Permission to make purchases by phone number.
  - `usePointsByPhone` boolean, required — Permission to spend points purchases by phone number.
  - `writeInvoice` boolean, required — Necessity to indicate a bill number when performing transactions through UDS Cashier.
  - `slug` string, required — Company slug for web page.

---

[API](https://skmtc.dev/uds/apis/uds-api.md) · [All operations](https://skmtc.dev/uds/apis/uds-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uds/uds-api/revisions/6fbbbc79e671/schema)