getTiersProgramSettings( )


Retrieves the settings for the tiers program.

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

Permissions
Read Loyalty
Manage Loyalty
Learn more about app permissions.
Method Declaration
Copy
function getTiersProgramSettings(): Promise<GetTiersProgramSettingsResponse>;
Request
This method does not take any parameters
Returns
Return Type:Promise<GetTiersProgramSettingsResponse>
JavaScript
import { tier } from "wix-loyalty-backend"; 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 * } * } * } */
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?