Skip to content

Apply add-on to customer

POST
/v1/add_ons/apply

Apply an add-on to a customer.

ApplyAddOnRequest
object
add_on_code
required
Add On Code
string
customer_id
required
Customer Id
string format: uuid
amount_cents
Any of:
number
amount_currency
Any of:
string
>= 3 characters <= 3 characters

Successful Response

AppliedAddOnResponse
object
id
required
Id
string format: uuid
add_on_id
required
Add On Id
string format: uuid
customer_id
required
Customer Id
string format: uuid
amount_cents
required
Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
amount_currency
required
Amount Currency
string
created_at
required
Created At
string format: date-time

Unauthorized

Add-on or customer 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