Administrative Workflows
¶ Review Active Programs
To manage active voucher programs:
- Listen for the
voucher_program_activated
webhook event. - Upon receiving the event, call GET voucher program details API to fetch the program’s start and end dates.
- Provide options to view/edit/cancel voucher programs in the UI.
Notes:
- Not all parameters can be updated when editing a voucher program. Refer to this section for details.
- Fields that cannot be updated should be grayed out in the UI.
- Use the search voucher program endpoint to enable customizable search functions in the UI.
- The
usage_amount
field tracks the amount spent on a voucher program or voucher code. - The
total_dollar_exposure
field from GET voucher program details API represents the maximum possible expenditure if fully utilized.
¶ Review Finished Programs
To manage completed voucher programs:
- Listen for the
voucher_program_completed
webhook event. - Upon receiving the event, call GET voucher program details API to retrieve usage details.
- If the voucher program uses the
MULTI_CODE_SINGLE_REDEEM
scheme, call the GET voucher codes API. - Track program spending using the
usage_amount
field. - Use the Search Voucher Program endpoint to enable customized searches in the UI.