Create Voucher Program without template
¶ Creating Voucher Program without Template
To create a new voucher program without template, use the Create Voucher Program endpoint (link).
Type of Code Schemes: Refer here
Type of Voucher Program Created
Uber supports vouchers for:
- Rides (
personal_transport
) - Eats (
eats
) - Both (
generic_voucher
)
Use the voucher_type
field to specify the applicable category.
Assigning Value to a Voucher Program
-
Amount-Based Vouchers (Fixed Discount)
-
SINGLE_CODE_MULTI_REDEEM (One Code, Multiple Redemptions)
- Use
redemptions_per_code
to define how many times a single voucher code can be used. - Example:
redemptions_per_code = 1
→ One customer can redeem it once.redemptions_per_code = 2
→ Two different customers can redeem the same code once each.
- Specify the value using:
value_per_trip_max_amount
: Max amount usable per redemption.value_per_period_max_trips
: Total number of trips allowed.
- Example:
value_per_trip_max_amount = 25
: Max$25
per trip.value_per_period_max_trips = 5
: One customer can use it 5 times ifredemptions_per_code = 1
.- If
redemptions_per_code = 2
, then two customers can each use it 5 times.
- Use
-
MULTI_CODE_SINGLE_REDEEM (Multiple Codes, Single Use Per Code)
- Use
number_of_codes
to define how many unique voucher codes are created. - Specify value using:
value_per_trip_max_amount
: Max spend per trip.value_per_period_max_trips
: Total number of trips allowed per code.
- Example:
number_of_codes = 1
→ Creates one unique voucher code.value_per_trip_max_amount = 25
,value_per_period_max_trips = 5
→ Customer can use the code for up to 5 trips, with a total max spend of$25
.
- Use
-
-
Flat Credit Off
- MULTI_CODE_SINGLE_REDEEM
- Required fields:
number_of_codes
,value_per_period_max_credit
- Example:
number_of_codes = 1
,value_per_period_max_credit = 25
- One unique code is generated for one customer. The customer can take multiple trips using the code until
$25
is fully used.
- Required fields:
- SINGLE_CODE_MULTI_REDEEM
- Required fields:
redemptions_per_code
,value_per_period_max_credit
- Example:
redemptions_per_code = 1
,value_per_period_max_credit = 20
- A single code can be shared with one customer. The customer can take multiple trips using the same code until
$20
is fully used.
- Required fields:
- MULTI_CODE_SINGLE_REDEEM
-
Percentage Off
- The voucher applies a percentage discount on the trip fare, with the discounted amount covered by the voucher issuer.
- You must specify either:
value_per_trip_max_amount
along withvalue_per_period_max_trips
ORvalue_per_period_max_credit
-
Deductible Amount
- The rider must pay a fixed deductible amount before the voucher applies to cover the remaining trip cost.
- You must specify either:
value_per_trip_max_amount
along withvalue_per_period_max_trips
ORvalue_per_period_max_credit
Note: If the trip/order cost exceeds the voucher value, the remaining amount is paid by the customer. Example: A
$100
trip with a$25
voucher means the customer pays$75
.
Voucher Restrictions
-
Vehicle Categories Use the
vehicle_category_types
field to restrict the voucher to specific vehicle categories:- PREMIUM – Includes Black and BlackSUV.
- ECONOMY – Includes UberX and UberXL.
- SHARED_RIDES – Includes Pool.
- If not set, all vehicle categories will be available.
-
Location Policy Type
PICKUP_OR_DROPOFF
– Restrict either the pickup or drop-off location.PICKUP_AND_DROPOFF
– Restrict both pickup and drop-off locations.PICKUP_ONLY
– Restrict only pickup locations.DROPOFF_ONLY
– Restrict only drop-off locations.
-
Geo Restrictions Geo restrictions can be applied using
pickup_locations
anddropoff_locations
. This can be implemented in two ways:- Address Input: The admin enters an address, which is then reverse-geocoded into latitude and longitude before making the API call.
- Interactive Map: The admin places a pin on a map, which translates the selected location into latitude and longitude for the API request.
Voucher Validity Refer here
Additional Voucher Program Parameters
- Name
- Expense Memo
- Vehicle Categories
- Voucher Type
- Admin Email
- Time Restrictions
- Location Restrictions
Recurrence Period
value_recurrence_period
defines how often the voucher resets:SINGLE
(default): No recurrence.DAILY
: Resets every day.MONTHLY
: Resets every month.
- Example:
value_recurrence_period = SINGLE
,value_per_period_max_credit = 50
→ Voucher provides$50
for the active window.value_recurrence_period = MONTHLY
,value_per_period_max_trips = 5
→ Customers can take 5 trips per month using the voucher, and the voucher value gets auto reset to 5 trips at the beginning of the next month.
Voucher Program Response The voucher program ID is returned upon creation. The response differs based on the code scheme.