Skip to content
Developer Portal Karmo Developer Portal

List cleansed partner pricing plans (proxy to vouch-turbo)

GET
/v1/inventory/plans

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Cleansed pricing plans

object
currency
required

ISO 4217 currency code; always “AUD” in V1

string
AUD
plans
required
Array<object>
object
id
required
string format: uuid
carLineId
required
string format: uuid
location
required
string
termMonths
required
integer
weeklyKmAllowance
required
integer
weeklyPrice
required
number
excessKmPrice
required
number

400

Section titled “400 ”

BAD_REQUEST

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

401

Section titled “401 ”

UNAUTHORIZED

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

403

Section titled “403 ”

FORBIDDEN

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

404

Section titled “404 ”

NOT_FOUND

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

409

Section titled “409 ”

CONFLICT

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

422

Section titled “422 ”

UNPROCESSABLE_ENTITY

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email

500

Section titled “500 ”

INTERNAL_SERVER_ERROR

object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
instance
string
karmoCode
required
string
/^[0-9]{8}$/
karmoErrors
Array<object>
object
detail
required

Human-readable detail for the specific field error.

string
pointer
required

JSON pointer to the offending value.

string
/email