HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Update contract

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

Updates an existing contract by its id based on the request.
Shall not be used in the way to add plan reference, start and end date in combination to expect starting a subscription.

Path Params
int64
required
Body Params

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

contractPriceAdaptationRequest
object | null

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

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.

string | null
[a-zA-Z0-9_.~@-]*

Optional ident of a previously uploaded image assigned to this contract.
If omitted, the current imageIdent remains unchanged.
If set to null, the assigned imageIdent is removed.

int64 | null
deprecated

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

string | null

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

string
enum
Defaults to de

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

paymentInformation
object | null
string | null
deprecated

DEPRECATED: Use paymentInformation update instead. The payment reference.

paymentTerm
object | null

Payment term for this contract.

string | null
enum
deprecated

DEPRECATED: Use paymentInformation update instead. The type of payment. 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.

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

Properties with additional information for template and bookkeeping. If updating the entire List will be updated.

properties
int64 | null
deprecated

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

string | null

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

date-time | null
deprecated

DEPRECATED: Use activation endpoint. The start date of the contract.

taxLocation
object | null

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

Responses

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?