loyaltyPointsBalance
Get the loyalty points balance for an account.
Arguments
The account number.
Deprecation
The 'accountNumber' field is deprecated.Please use input object with accountNumber (+ optional accountUserId).
- Marked as deprecated on 2025-08-14.
- Scheduled for removal on or after 2025-09-14.
Returns
AccountLoyaltyPointsTypePossible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-7899: An internal error occurred.
- KT-CT-9215: Loyalty points balance query disabled.
- KT-CT-9216: Unauthorized.
- KT-CT-9217: Unauthorized.
- KT-CT-9218: Unauthorized.
- KT-CT-9222: Loyalty points balance query requires either accountNumber field (deprecated) or input object (preferred) with account number and optional account user id.
Allowed Viewers
Required Permissions
Can query loyalty points balanceQuery Complexity
1Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
query LoyaltyPointsBalance($input: LoyaltyPointsBalanceInput) {
loyaltyPointsBalance(input: $input) {
loyaltyPoints
totalMonetaryAmount
}
}
Variables
{
"input": LoyaltyPointsBalanceInput
}
Response
{
"data": {
"loyaltyPointsBalance": {
"loyaltyPoints": 3,
"totalMonetaryAmount": 4
}
}
}