Sign in

v1

latestOpenAPI 3.0.02026-07-247251950.2 KB
Vouchers

Create a new voucher

Overview

Create discount vouchers that customers can apply to their hotel and flight bookings. Supports percentage discounts, fixed amounts, and points redemption vouchers.

When to Use

  • Promotional campaigns - Create discount codes for marketing
  • Customer rewards - Generate vouchers for loyal customers
  • Special offers - Create time-limited discount vouchers
  • Points redemption - Generate vouchers from loyalty points

What You Get

  • Voucher object - Complete voucher details including code and settings
  • Usage tracking - Remaining uses count
  • Validation - Confirmation that the voucher was created successfully

Key Features

  • Multiple discount types - Percentage, fixed amount, or points redemption
  • Flexible rules - Set minimum spend, maximum discount, and usage limits
  • Validity control - Define start and end dates
  • Guest assignment - Optionally assign to specific guests
  • Applies to hotels and flights - Pass the voucherCode in the voucherCode field of /rates/prebook (hotels) or /flights/prebooks (flights) to redeem the discount at checkout

Quick Start

Provide voucher code, discount type, value, currency, validity dates, usage limits, and status. Returns the created voucher with all details.

post/vouchers

Request body

voucher_codestring required

A unique code for the new voucher. e.g. manhattan-holidays-100

discount_typestring required

Type of discount, such as percentage, or points_redemption

discount_valuenumber required

Value of the discount applied by the voucher. For percentage discounts, a value of 10 represents a 10% discount. For points_redemption, it indicates the fixed amount of points to be redeemed e.g. 10 equals 10 points

minimum_spendnumber required

Minimum rate to apply the discount voucher in the voucher currency. e.g. a minimum_spend of USD$100 will only apply for bookings with a price USD$100 or more

maximum_discount_amountnumber required

Maximum discount amount that can be applied using the voucher in voucher currency. e.g. a with a maximum_discount_amount of 50 in USD, will discount from 0 to USD$50

currencystring required

Currency in which the discount is offered

validity_startstring date required

Date from which the voucher becomes valid

validity_endstring date required

Date until which the voucher remains valid

usages_limitnumber required

Maximum number of times the voucher can be redeemed

statusstring required

Current status of the voucher (e.g., active, inactive)

guest_idstring

The unique identifier of the guest associated with the voucher

descriptionstring

A brief description of the voucher, detailing its purpose or offer

terms_and_conditionsstring

Terms and conditions associated with the voucher

budgetnumber

Total monetary pool the voucher can distribute across all redemptions, in the voucher's currency. If not set or 0, there is no monetary limit and usage is only controlled by usages_limit. When set, budget and usages_limit act as independent limits — whichever is exhausted first will reject the voucher.

Response

Voucher created successfully