HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create option

post
https://api.instellix.io/v2/billing/plan-options

An option is a product or service that should be billed in a given phase. The option can have one of the types ONETIME, QUANTITY, RECURRING, USAGE or RATED_USAGE.

Body Params

An Option that defines for which existing options commissions will be paid.

string | null

e.g. article number, SKU, ISBN, not unique. Max 32 Chars. Size must be between 0 and 32.

string | null
enum
Defaults to SERVICE

The option's line item category. Must be one of:

string | null

Description of the product in human readable form. Size must be between 0 and 255.

boolean | null

If the option is individual, it can be only assigned to one plan.

string | null

The item group to which an item belongs. Max 64 chars. Size must be between 0 and 64.

string
required
length between 1 and 255

Name of the product or service in human readable form. To be used to be displayed on pdf documents. Must not be blank. Size must be between 1 and 255.

string | null

Operating site of the option. Only predefined operating site identifiers are allowed. Size must be between 0 and 255.

string | null

Unique Identifier for an option. An uuid is generated if not provided. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

string | null

Name displayed in option catalog, not used to be displayed on pdf documents. Size must be between 0 and 255.

string
required
length between 1 and 100

Must be a unique external reference. Cannot be amended after the initial POST. Must not be null. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

properties
array of objects | null

List of all properties for this option.

properties
string
enum
required

Type of the option. Must be one of:. Must not be null.

Allowed:
string

Option that, when invoiced, will trigger a commission.

string
enum
Defaults to EUR
deprecated

DEPRECATED. Should now be configured in the 'pricing' section. The option's currency. Must be one of:

string
enum

Item type

Allowed:
string
enum
Defaults to SALES

Invoicing agreement type of an option

Allowed:
number
deprecated

DEPRECATED. Should now be configured in the 'pricing' section. Net price of the option excluding vat.

prices
array of objects
required

Defining the price per country. Must not be null.

prices*
string
enum
Defaults to SERVICE
deprecated

DEPRECATED. Should now be configured in 'category'. The option's purchase item type. Must be one of:

string
enum
deprecated

DEPRECATED. Should now be configured in the 'pricing' section. The country where the product or service will be sold. Should be a valid ISO 3166-1 alpha-2 code.

string
deprecated

DEPRECATED. Should now be configured in the 'pricing' section. Name of tax code which specifies tax rate, type of tax and calculation method of the country where billing takes place.

string
enum
deprecated

DEPRECATED. Should now be configured in the 'pricing' section. It defines tax trading procedure of an item.

Allowed:
Responses

Updated 27 days ago

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 27 days ago