Get Loyalty Settings
GET/api/loyalty/settings
The tenant's loyalty program configuration.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token (PAT).
Permission: pos.operate.
Returns 200 with { data: { enabled, points_per_dollar, redemption_value_per_point, min_redemption_points } }:
enabled(boolean) — whether the program is active (default false).points_per_dollar(float) — points earned per $1 of sale total before tax (default 1.0).redemption_value_per_point(float) — dollar value of one point when redeemed (default 0.01).min_redemption_points(integer) — minimum points a customer must hold before any can be redeemed (default 0).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.