HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create contract

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

A request to create a new contract. It ties a preconfigured plan to an existing customer, in order to bill the services as defined in the underlying plan.

Body Params

Please see Plan Model below for more information regarding required values and input type.

date | null

The date when actual billing starts for this contract. If left empty the contract will be billed from the startDate.

int64 | null
deprecated

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

string | null

The Ident of the business segment for the Plan. The default segment will be used if not set.

string
required
length between 1 and 100

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

contractPriceAdaptation
object | null

Optional reference of the price adaptation used to automatically adapt this contracts prices.

string | null
enum
deprecated

DEPRECATED. Deprecated: Use tax location and performance location instead. Country that determines which price and tax will be applied and which price picked for subscriptions and one time options for this contract. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.

string | null

Optional coupon code to apply to the contract on creation.

date-time
required

Defines when the contract is signed. Must not be null.

int64 | null
deprecated

DEPRECATED. Must be the correct debtorId to which the contract will be assigned. Either debtorId or debtorIdent must present. DebtorIdent is preferred.

string | null

Must be the correct debtorIdent to which the contract will be assigned. Size must be between 0 and 100. Must match with the regular expression '[a-zA-Z0-9_.~@-]*'.

string | null
enum
deprecated

DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration type. Must be one of:

Allowed:
int32 | null
deprecated

DEPRECATED: Replaced by contract term configuration in your plans and phases. The duration of the contract.

date-time | null
deprecated

DEPRECATED: Explicitly terminate the contract using our contract termination endpoints instead. Usage of this field can result in unexpected behavior.

int64 | null
deprecated

DEPRECATED. Deprecated: Must be the correct ID for the invoice address of the debtor to which the contract will be assigned. Please use non-deprecated invoiceAddressIdent.

string | null

Must be the correct ident for the invoice address of the debtor to which the contract will be assigned.

string | null
enum
Defaults to de

Optional language code in ISO 639-1 standard. Must be one of business segment valid languages.

lineItems
array of objects | null

A list of line items included in the contract. Please see Line Item Model for more details

lineItems
optionQuantities
array of objects
required

Must not be null.

optionQuantities*
paymentInformation
object | null

A request to specify payment-related details.

string | null
deprecated

DEPRECATED. The payment reference. Deprecated, PaymentInformation structure should be used instead

paymentTerm
object | null

Specifies a payment term.

string | null
enum
deprecated

DEPRECATED. Deprecated, PaymentInformation structure should be used instead. The type of payment. Payment method. See documentation for valid values.

NOTE: This field also supports the legacy variants.

performanceLocation
object | null

Where the service has been provided. Used for tax calculation and can be printed on documents.

int64 | null
deprecated

DEPRECATED. Deprecated: Reference to the Plan to use for the contract.

string | null

Reference to the Plan to use for the contract.

planModifiers
array | null

Modifiers to apply to a plan and its options to change i.e. the price. Are applied only to this contract.

planModifiers
properties
array of objects | null

Additional contract properties to specify the contract.

properties
relatedContracts
array of objects | null

Contracts that might have a billing impact from this contract, for example, because they receive a commission.

relatedContracts
serviceLocation
object | null
deprecated

Deprecated: Use detailedTaxLocation and detailedPerformanceLocation instead. The location where the product or service was sold.

int64 | null
deprecated

DEPRECATED. Deprecated: Optional ID of the shipping address to which the contract will be assigned. Please use non-deprecated shippingAddressIdent.

string | null

Optional ident of the shipping address to which the contract will be assigned.

date-time | null

Defines start of the active period of the contract. Remains as is even if it was cancelled or terminated before activation start.

taxLocation
object | null

Where the service is taxable. Can be provided but might be overwritten during tax calculation.

Responses

Updated 27 days ago

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

Updated 27 days ago