> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetTiersProgramSettings

# Package: loyaltyProgramManagement

# Namespace: LoyaltyTiers

# Method link: https://dev.wix.com/docs/api-reference/crm/loyalty-program/loyalty-program-management/tiers/get-tiers-program-settings.md

## Permission Scopes:
Read Loyalty: SCOPE.DC-LOYALTY.READ-LOYALTY

## Introduction

Retrieves the settings for the tiers program. Tiers program settings apply globally to all tiers in the program.

---

## REST API

### Schema

```
 Method: getTiersProgramSettings
 Description: Retrieves the settings for the tiers program. Tiers program settings apply globally to all tiers in the program.
 URL: https://www.wixapis.com/v1/tiers/program-settings
 Method: GET
 Return type: GetTiersProgramSettingsResponse
  - name: programSettings | type: TiersProgramSettings | description: Tiers program settings. 
     - ONE-OF: 
        - name: rollingWindow | type: RollingWindow | description: **Required.** Period of time used to calculate loyalty points for tier assignment.  The loyalty points accumulated during this period determine if the account meets a tier's required point threshold. 
           - name: durationInMonths | type: integer | description: Number of months to use for the rolling window period.  Min: `12`  Max: `36` 
     - name: status | type: Status | description: Tiers program status. 
         - enum:
         -     UNKNOWN: Unknown status.
         -     DISABLED: Tiers are disabled.
         -     DRAFT: Tiers are enabled but not yet active.
         -     ACTIVE: Tiers are active.
         -     PAUSED: Tiers are paused.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the loyalty tiers settings are updated.  To prevent conflicting changes, the current `revision` must be passed when updating the loyalty tiers settings. 
     - name: createdDate | type: string | description: Date and time the loyalty tiers program was created. 
     - name: updatedDate | type: string | description: Date and time the loyalty tiers program was last updated. 
     - name: baseTierDefinition | type: TierDefinition | description: Information about the base loyalty tier.  The base tier is the default tier for any account that's unassigned for not meeting the required points threshold of any other tier. 
        - name: icon | type: Image | description: Details about the tier icon. 
           - name: id | type: string | description: WixMedia image GUID. 
           - name: url | type: string | description: Image URL. 
           - name: height | type: integer | description: Original image height. 
           - name: width | type: integer | description: Original image width. 
           - name: altText | type: string | description: Image alt text. 
           - name: filename | type: string | description: Image filename. 
        - name: name | type: string | description: Tier name. 
        - name: description | type: string | description: Tier description. 


```

### Examples

### Get tiers program settings
```curl
curl -X GET \
  'https://www.wixapis.com/loyalty-tiers/v1/tiers/program-settings \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.loyaltyProgramManagement.LoyaltyTiers.getTiersProgramSettings()
 Description: Retrieves the settings for the tiers program. Tiers program settings apply globally to all tiers in the program.
 Return type: PROMISE<GetTiersProgramSettingsResponse>
  - name: programSettings | type: TiersProgramSettings | description: Tiers program settings. 
     - ONE-OF: 
        - name: rollingWindow | type: RollingWindow | description: **Required.** Period of time used to calculate loyalty points for tier assignment.  The loyalty points accumulated during this period determine if the account meets a tier's required point threshold. 
           - name: durationInMonths | type: integer | description: Number of months to use for the rolling window period.  Min: `12`  Max: `36` 
     - name: status | type: Status | description: Tiers program status. 
         - enum:
         -     UNKNOWN: Unknown status.
         -     DISABLED: Tiers are disabled.
         -     DRAFT: Tiers are enabled but not yet active.
         -     ACTIVE: Tiers are active.
         -     PAUSED: Tiers are paused.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the loyalty tiers settings are updated.  To prevent conflicting changes, the current `revision` must be passed when updating the loyalty tiers settings. 
     - name: _createdDate | type: Date | description: Date and time the loyalty tiers program was created. 
     - name: _updatedDate | type: Date | description: Date and time the loyalty tiers program was last updated. 
     - name: baseTierDefinition | type: TierDefinition | description: Information about the base loyalty tier.  The base tier is the default tier for any account that's unassigned for not meeting the required points threshold of any other tier. 
        - name: icon | type: string | description: Details about the tier icon. 
        - name: name | type: string | description: Tier name. 
        - name: description | type: string | description: Tier description. 


```

### Examples

### Get tiers program settings
```javascript
import { tiers } from "@wix/loyalty";

export async function myGetProgramSettingsFunction() {
  try {
    const tiersProgramSettings = await tier.getTiersProgramSettings();

    const status = tiersProgramSettings.programSettings.status;
    const revision = tiersProgramSettings.programSettings.revision;

    console.log("Success! Current status of tiers program: ", status);
    return tiersProgramSettings;
  } catch (error) {
    console.error(error);
  }
}

/* Promise resolves to:
 *
 * {
 *   "programSettings": {
 *     "_createdDate": "2024-06-05T20:27:19.147Z",
 *     "_updatedDate": "2024-06-06T10:30:05.261Z",
 *     "baseTierDefinition": {
 *       "icon": "shapes/11062b_0a8e17936d5b4d46971649be036c781b.svg",
 *       "name": "Basic",
 *       "description": ""
 *     },
 *     "revision": "2",
 *     "status": "ACTIVE",
 *     "rollingWindow": {
 *       "durationInMonths": 12
 *     }
 *   }
 * }
 */
```

### getTiersProgramSettings (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { tiers } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { tiers },
  // Include the auth strategy and host as relevant
});


async function getTiersProgramSettings() {
  const response = await myWixClient.tiers.getTiersProgramSettings();
};
```

---