HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Update plan

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

Request to update a plan. If a plan holds an active contract then update is limited tothe plan name and its properties - to be propagated for all future documents.

Path Params
int64
required
Body Params

The updated plan

int64 | null
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 | null

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

boolean | null

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

string | null

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 | null

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*

A plan has one or more phases. A phase contains one or more options. Phases are intended for plans that have changes in price, billing interval or included products/services at a predefined point in time. Creating options while creating a plan is deprecated: Use the Option API instead to manage Options and reference them when creating a plan.

boolean | null
deprecated

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

billingConfig
object | null

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

string | null

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 | null

A list of linked options

linkedOptions
string | null

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

noticePeriod
object | null

Specifies a time duration

options
array | null
deprecated
options
termDuration
object | null

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 | null

A list of transitions.

transitions
properties
array of objects | null

Additional plan properties.

properties
string | null

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 27 days ago

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

Updated 27 days ago