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

articleNumber

string

length ≤ 32

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

category

string

enum

Defaults to SERVICE

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

description

string

length ≤ 255

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

individualOption

boolean

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

itemGroup

string

length ≤ 64

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

name

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.

operatingSiteIdent

string

length ≤ 255

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

optionIdent

string

length between 1 and 100

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}'.

optionName

string

length ≤ 255

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

productIdent

string

required

length between 1 and 100

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

properties

array of objects

List of all properties for this option.

properties

type

string

enum

required

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

Allowed:

commissionedOptionIdent

string

Option that, when invoiced, will trigger a commission.

currency

string

enum

Defaults to EUR

deprecated

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

debitCreditIndicator

string

enum

Item type

Allowed:

invoicingAgreementType

string

enum

Defaults to SALES

Invoicing agreement type of an option

Allowed:

itemPriceNet

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.

prices*

purchaseItemOptionType

string

enum

Defaults to SERVICE

deprecated

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

serviceCountry

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.

taxCode

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.

taxScheme

string

enum

deprecated

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

Allowed:

Responses

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX