Create add-on

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Name of add-on. Will be used as order line text.

string

Optional description of add-on

int32
required
≥ 0

Add-on amount

float

Optional vat for add-on. Account default is used if none given.

string
enum
required

Add-on type on_off or quantity. An on_off type cannot be given a quantity when attached to subscription. For quantity type it is possible. Type can only be updated from on_off to quantity. It is not allowed to change type from quantity to on_off.

Allowed:
string
required
length ≥ 1

Per account unique handle for the add-on

metadata
object

Custom metadata.

string

Currency for the add-on in ISO 4217 three letter alpha code. If not provided the account default currency will be used.

boolean

Whether the amount is including VAT. Default true.

string

Optional tax policy handle for add-on. Account default is used if none given.

boolean

Whether all plans are eligible for this add-on. Defaults to false.

eligible_plans
array of strings

If not all_plans are set to true, then the set of eligible plan handles must be defined.

eligible_plans
entitlements
array of strings

List of entitlement handles for the add-on.

entitlements
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json