Use this API to check how many loyalty points and the loyalty amount (in $) that a guest can redeem while paying for an invoice.
You must specify appropriate details for the InvoiceId parameter. Optionally, you can provide the required values for the lp_program_id and redeem_across_programs parameters.
Response Details
Name
Type
Description
lp_redeemable
object
Object that contains the guest's redeemable loyalty points-related elements. For more information, refer to the lp_redeemable Object table.
error
object
Object that contains the error message and error code-related details. For more information, refer to the error Object table.
lp_redeemable Object
Name
Type
Description
points
decimal
Number of loyalty points that the guest can use to pay for the invoice.
amount
decimal
Loyalty points amount (in $) that the guest can use to pay for the invoice.
loyalty_programs
object
Object that contains the guest's loyalty programs-related elements. For more information, refer to the loyalty_programs Object table.
total_available_points
decimal
Total loyalty points that is available for the guest across all loyalty programs.
total_available_amount
decimal
Total loyalty points amount (in $) that is available for the guest across all loyalty programs.
exchange_rate
decimal
Rate of conversion of one loyalty point as a dollar amount.
loyalty_programs Object
Name
Type
Description
id
guid
Unique 32-character identifier of the guest's loyalty program.
name
string
Name of the guest's loyalty program.
points
object
Object that contains the guest's loyalty points-related elements for the specific loyalty program. For more information, refer to the points Object table.
points Object
Name
Type
Description
earned
decimal
Number of loyalty points that the guest has earned in the loyalty program.
redeemed
decimal
Number of loyalty points that the guest has redeemed in the loyalty program.
available
decimal
Number of loyalty points that the guest can redeem in the loyalty program.
error Object
Error Code
Error Message
502
invoice_id is not valid.
502
ProgramId is not valid.
Language
Credentials
Header
Click Try It! to start a request and see the response here!
