DATE:
AUTHOR:
The Toast - API team
Menus API Objects, fields, and values

eligiblePaymentAssistancePrograms added to MenuItem object in menus API

DATE:
AUTHOR: The Toast - API team

The MenuItem object has been updated with an eligiblePaymentAssistancePrograms value. This value contains an array of strings that indicate which payment assistance programs may be used to pay for the menu item. Possible strings include SNAP.

The eligiblePaymentAssistancePrograms array is empty if no eligible assistance programs have been assigned to the menu item.

The eligiblePaymentAssistancePrograms value is primarily used by Toast Retail services. It allows retail locations to charge a menu item to an electronic benefits transfer (EBT) card associated with one of the eligible assistance programs assigned to that item. Currently, only the United States Supplemental Nutrition Assistance Program (SNAP) program is supported.

This new value will become available in the menu API response data after a location has made a menus-related change and published the new menu, which initiates regeneration of the location's menus data. For more information, see Menus API returns published data only.

This change applies to both V2 and V3 of the menus API.

For information on the differences between V2 and V3 of the menus API, see Comparing menus API V2 and V3.

Powered by LaunchNotes