Skip to content

Purchase an add-on

POST
/portal/add_ons/{add_on_id}/purchase

Purchase an add-on. Creates an applied add-on record and a one-off invoice.

add_on_id
required
Add On Id
string format: uuid
token
required
Token
string

Successful Response

PortalPurchaseAddOnResponse

Response after purchasing an add-on.

object
applied_add_on_id
required
Applied Add On Id
string format: uuid
invoice_id
required
Invoice Id
string format: uuid
add_on_name
required
Add On Name
string
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
amount_currency
required
Amount Currency
string

Invalid or expired portal token

Add-on not found

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