Uber Developers

Uber

Developers

Get Voucher Templates

GEThttps://api.uber.com/v1/organizations/{organization_id}/voucher-program-templates

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

¶ Use Case

The Get Voucher Templates endpoint allows you to get the list of voucher templates by organization ID.

¶ Authorization

The Get Voucher Templates endpoint requires an access_token using the client credentials grant to organizations.voucher_programs scope or using authorization_code to organizations.voucher_programs.delegated scope.

If an application follows third party authentication, this endpoint requires organizations.voucher_programs.aggregator scope with the grant type as client_credentials.

¶ Path Parameters

Name	Type	Optional	Description
`organization_id`	string	No	Identifier for the organization the developer is part of and the entity that owns this voucher program. Should be known to developer when their organization was onboarded to Uber For Business.

¶ Response Fields

Name	Type	Description
uuid	string	Program Template uuid
creator_uuid	string	Template Creator uuid
created_at	int	Template Creation time from epoch in milliseconds
is_disabled	boolean	True if Template has been disabled
template_name	string	Template Name
campaign_name	string	Default Campaign Name
timezone	string	Timezone of the voucher program. List of valid timezones as input can be seen under the ‘TZ’ column here, https://en.wikipedia.org/wiki/List_of_tz_database_time_zone. If no Timezone is set, the default timezone of UTC will be used and returned back in the get call.
currency_code	string	Currency of the offer value (in ISO 4217 format)
is_fully_covered	boolean	True if trips are fully covered
deductible	float	Amount of the trip fare covered by the rider before being charged to the voucher issuer.
percentage	int	Percentage of the trip fare that will be charged to the voucher issuer. The range for this field is [5, 99]. The default value is one hundred. If this field is customized, value_per_trip_deductible is disallowed to set non-default values. If value_per_trip_max_amount is set, that value is respected over the percentage. Ex: If set to 20, and value_per_trip_max_amount is set to 5 then: for a $10 fare, $2 will be charged to the voucher issuer. For a $30 fare, $5 will be charged to the voucher issuer.
cap	float	Maximum dollar amount each voucher can cover on each trip fare. Any overage amount will be charged to the rider. This field is required unless value_per_period_max_credit is set, in which case it will be set to value_per_period_max_credit. ($200 absolute max)
voucher_type	string	Specifies the product the voucher can be used for. Possible values are one of the below: PERSONAL_TRANSPORT Voucher used for Uber Rides EATS Voucher used for Uber Eats GENERIC_VOUCHER Voucher used for Uber Rides or Uber Eats

¶ Example Request

curl -H 'Authorization: Bearer <TOKEN>'
     -H 'Accept-Language: en_US'
     -H 'Content-Type: application/json'
     'https://api.uber.com/v1/organizations/<organization_id>/voucher-program-templates'

¶ Example Response

Status-Code: 200 OK

{
  "results": [
    {
      "uuid": "a1111c8c-c720-46c3-8534-2fcdd730040d",
      "creator_uuid": "<creator_uuid>",
      "created_at": 239100000,
      "is_disabled": false,
      "template_name": "<template_name>",
      "campaign_name": "<default_campaign_name>",
      "timezone": "EST",
      "currency_code": "USD",
      "is_fully_covered": false,
      "deductible": 0,
      "percentage_off": 10,
      "cap": 100.0,
      "voucher_type": "EATS"
    }
  ]
}

¶ Error Responses

HTTP Status	Code	Description
400	`invalid_request`	This request is invalid
403	`unauthorized`	Requester not allowed to perform requested action. When the third party app (3P) is not authorized by the U4B organization
500	`internal_server_error`	We have experienced a problem

Uber

Developers