HomeDocumentationAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference

Create migration path

Create a migration path with the given properties.

Path Params
string
required
length between 1 and 100
[a-zA-Z0-9_.~-]{1,100}

The ident of the source plan for the migration path.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

Body Params

A request to create a migration path.
A migration path defines whether and how a change from one contract's plan into another is possible.

billing
object | null

The billing terms to use when changing plans.

configuration
object | null

The configuration to use when changing plans.

string | null

The migration path's description.
Size must be between 0 and 255.

string | null
[a-zA-Z0-9_.~-]{1,100}

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

string
required
length ≤ 255

The migration path's name.
Must not be blank.
Size must be between 0 and 255.

target
object
required

The definition of possible targets for a plan change using this migration path.

Responses

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