The Adjust Terms API is specifically designed for vehicle suppliers providing rental and financing services. It will allow them to increase or decrease a driver’s liability in lieu of car damages, cash payments etc.

¶ Use case

By using the Adjust Terms API, suppliers can easily adjust a terms liability.

¶ Support for Hierarchical Data

The API operates within the hierarchical structure of the organization linked to the developer’s account at the time of setup.

¶ Supported supplier types

Financiers/Rentals

¶ Scopes

All of - vehicle_suppliers.terms.management, vehicle_suppliers.terms.adjustment

¶ Resource

/v1/vehicle-supplier/terms/:terms_id/adjust-balance

¶ HTTP Method

POST

¶ Authorization

Client Credentials

¶ Example Request

curl -X POST "https://api.uber.com/v1/vehicle-supplier/terms/:terms_id/adjust-balance" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <TOKEN>" \
--data '{
  "idempotencyKey": {
    "value": "<uuid>"
  },
  "amount": {
    "amountE5": 10000,
    "currencyCode": "MXN"
  },
  "description": "some desc",
  "adjustmentType": "ADJUSTMENT_TYPE_DEBIT"
}'

¶ Request Path Parameters

Name	Type	Description
terms_id	string	Terms ID returned from Create Terms response

¶ Request Body Parameters

Name	Type	Description
idempotencyKey	object	UUID object in UUIDv4 format
amount	object	Amount object, representing absolute value to be adjusted
description	string	Description for the adjustment
adjustmentType	enum	Adjustment type enum

¶ Adjustment Type

NAME	DEFINITION
ADJUSTMENT_TYPE_DEBIT	Increase the liability by specified amount
ADJUSTMENT_TYPE_CREDIT	Decrease the liability by specified amount

¶ Example Response

Status-code: 200
{
    "adjustmentSubmitted": true
}

¶ Response Body Parameters

Name	Type	Description
adjustmentSubmitted	bool	Signifies that the charge has been accepted and will be processed asynchronously

Rate limit

• The rate limit for this endpoint is 1 request per second.

¶ Endpoint Specific Errors

Http Status Code	Code	Message
400	bad_request	The request parameters are invalid, out-of-range, rate limited, code cancelled etc.
401	unauthorized/permission denied
500	internal_server_error	Internal server error

Note

• Adjustments will only be allowed for terms that have/had been accepted by the driver
• Charges submitted can be rejected later in the system. Use transactions report for transactions status.