HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint
Start typing to search…

Create plan

post
https://api.instellix.io/v2/plans

A request to create a new plan. A plan is the basis for a contract with recurring payments. It is not assigned to a specific debtorId and can be used across multiple contracts like a template. After a contract is assigned to a plan with phases and options, usages are created which result in billable items for the debtor. Creating options while creating a plan is deprecated: Use the Option API instead to manage Options and reference them when creating a plan.

Body Params
int64
deprecated

DEPRECATED. Deprecated: Use business segment ident instead. The Id of the business segment for the Plan. The default segment will be used if not set.

string

Determines to which business segment this plan belongs. Should be set, if not set the deprecated "businessSegmentId" needs to be set instead.

boolean

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

string

The ident of the phase that will be started at first.

string
required
length between 1 and 255

Name of the plan. Must not be blank. Size must be between 1 and 255.

pendingContractTerms
object

Configure terms that are applicable for the time between signing and the start of the contract.

phases
array of objects
required
length ≥ 1

Must not be empty.

phases*
boolean
deprecated

DEPRECATED. Deprecated: Phase transition should be used instead. When set to true, contracts are automatically renewed, when a term has passed

billingConfig
object

The new API to configure billing details on phase level. Using these properties will ignore the billingStrategyField from options within this phase.

string
length between 1 and 100

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

linkedOptions
array of objects

A list of linked options

linkedOptions
string
length ≤ 255

Name of the phase. Size must be between 0 and 255.

noticePeriod
object

Specifies a time duration

options
array
deprecated

DEPRECATED

options
termDuration
object

Specifies a time duration

boolean
Defaults to true

When set to true, contracts end at the end of the interval at the end of the month, independent from when the contract started

transitions
array of objects

A list of transitions.

transitions
string
required
length between 1 and 100
Defaults to 4564-45654-2154-2324

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
properties
string

The type of plan. Must be one of:. Must be one of:

CUSTOMERPlans with the main goal of invoicing customers. Can't contain COMMISSION options.
PARTNERPlans with the main goal of crediting partners. Has to contain at least one COMMISSION option.
Responses

Updated 7 months ago

Language
Credentials
OAuth2
Missing 1 required scope
Response 
 Choose an example:
application/json
Updated 7 months ago