Skip to main content
POST
Assign add-on

Authorizations

X-API-Key
string
header
required

Preferred. API key value directly.

Query Parameters

platformId
string

Your platform id.

Example:

"pf_1"

userId
string

Target user id.

Example:

"usr_123"

addonId
string

Add-on plan id (itemType=addon). planId accepted as alias.

Example:

"addon_1"

billingCycle
string

monthly | quarterly | annual | onetime.

quantity
number

Quantity override.

Example:

1

Body

application/json
platformId
string
required

Your platform id.

Example:

"pf_1"

userId
string
required

Target user id.

Example:

"usr_123"

addonId
string
required

Add-on plan id (itemType=addon). planId accepted as alias.

Example:

"addon_1"

billingCycle
string

monthly | quarterly | annual | onetime.

quantity
number

Quantity override.

Example:

1

Response

Success. Envelope: { success:true, data, message? }.

success
boolean
required
Example:

true

data
any
message
string
pagination
object
total
number
Last modified on September 20, 2026