Skip to content
BoxBilling

Get add-on

GET
/v1/add_ons/{code}

Get an add-on by code.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
code
required
Code
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

AddOnResponse
object
id
required
Id
string format: uuid
code
required
Code
string
name
required
Name
string
description
Any of:
string
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
amount_currency
required
Amount Currency
string
invoice_display_name
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

401

Section titled “401 ”

Unauthorized

404

Section titled “404 ”

Add-on not found

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object