Get points balance | FluxStore Docs

GET/api/v1/loyalty/balance

Look up a player’s loyalty points balance by username. Reading a balance is not Pro gated.

playerstringrequired

The player’s username.

X-Api-Keystringrequired

Your API key.

playerUsernamestringrequired

The player’s username.

balancenumberrequired

Current points balance.

labelSingularstringrequired

Singular currency label configured for the store.

labelPluralstringrequired

Plural currency label configured for the store.

GET/api/v1/loyalty/balance


curl -H "X-Api-Key: flx_XXXX_XXXXXXXX" \
  "https://api.fluxstore.net/api/v1/loyalty/balance?player=Steve"

200OK


{
  "success": true,
  "data": {
    "playerUsername": "Steve",
    "balance": 500,
    "labelSingular": "Point",
    "labelPlural": "Points"
  }
}