Copy PageCreate contractpost https://api.instellix.io/v2/contractsA 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 ParamsPlease see Plan Model below for more information regarding required values and input type.billingStartDatedate | nullThe date when actual billing starts for this contract. If left empty the contract will be billed from the startDate.businessSegmentIdint64 | nulldeprecatedDEPRECATED. The business segment of a contract is determined by its plan. If not set, the business segment of the plan is used. If set, it must match the business segment of the plan. This field will be removed in a future version.businessSegmentIdentstring | nulldeprecatedDEPRECATED. The business segment of a contract is determined by its plan. If not set, the business segment of the plan is used. If set, it must match the business segment of the plan. This field will be removed in a future version.contractIdentstringrequiredlength between 1 and 100[a-zA-Z0-9_.~-]{1,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.contractPriceAdaptationobject | nullOptional reference of the price adaptation used to automatically adapt this contracts prices.contractPriceAdaptation object | nullcountrystring | nullenumdeprecatedDEPRECATED. 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.DEUNDEFINEDACADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCPCRCSCUCVCWCXCYCZDEDGDJDKDMDODZEAECEEEGEHERESETEUEZFIFJFKFMFOFRFXGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUICIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUKUMUSUYUZVAVCVEVGVIVNVUWFWSXIXUXKYEYTYUZAZMZRZWShow 272 enum valuescouponApplicationobject | nullOptional coupon application to validate and prepare when creating the contract.Coupon application request object | nulldatedate-timerequiredDefines when the contract is signed. Must not be null.debtorIdint64 | nulldeprecatedDEPRECATED. Must be the correct debtorId to which the contract will be assigned. Either debtorId or debtorIdent must present. DebtorIdent is preferred.debtorIdentstring | null[a-zA-Z0-9_.~@-]*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_.~@-]*'.durationTypestring | nullenumdeprecatedDEPRECATED: Replaced by contract term configuration in your plans and phases. The duration type. Must be one of:MONTHDAYMONTHYEARFOREVERAllowed:DAYMONTHYEARFOREVERdurationValueint32 | nulldeprecatedDEPRECATED: Replaced by contract term configuration in your plans and phases. The duration of the contract.endDatedate-time | nulldeprecatedDEPRECATED: Explicitly terminate the contract using our contract termination endpoints instead. Usage of this field can result in unexpected behavior.imageIdentstring | null[a-zA-Z0-9_.~@-]*Optional ident of a previously uploaded image assigned to this contract. Size must be between 0 and 100. Must match with the regular expression '[a-zA-Z0-9_.~@-]*'.invoiceAddressIdint64 | nulldeprecatedDEPRECATED. 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.invoiceAddressIdentstring | nullMust be the correct ident for the invoice address of the debtor to which the contract will be assigned.languagestring | nullenumDefaults to deOptional language code in ISO 639-1 standard. Must be one of business segment valid languages.undefinedaaabaeafakamanarasavayazbabebgbhbibmbnbobrbscacechcocrcscucvcydadedvdzeeeleneoeseteufafffifjfofrfygagdglgngugvhahehihohrhthuhyhziaidieigiiikioisitiujajvkakgkikjkkklkmknkokrkskukvkwkylalblglilnloltlulvmgmhmimkmlmnmrmsmtmynanbndnengnlnnnonrnvnyocojomorospapiplpsptqurmrnrorurwsascsdsesgsiskslsmsnsosqsrssstsusvswtatetgthtitktltntotrtstttwtyugukuruzvevivowawoxhyiyozazhzuShow 185 enum valueslineItemsarray of objects | nullA list of line items included in the contract. Please see Line Item Model for more detailslineItemsADD objectoptionAllowancesarray of objects | nullOption allowances to create together with the contract.optionAllowancesADD objectoptionQuantitiesarray of objectsrequiredMust not be null.optionQuantities*ADD objectpaymentInformationobject | nullInformation about the payment for the contract.paymentInformation object | nullpaymentReferencestring | nulldeprecatedDEPRECATED. The payment reference. Deprecated, PaymentInformation structure should be used insteadpaymentTermobject | nullPayment term for this contract.paymentTerm object | nullpaymentTypestring | nullenumdeprecatedDEPRECATED. 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.APPLE_PAYCREDITCARDPAYPALDIRECTDEBITWIRETRANSFERALIPAYWECHATUNIONPAYPURCHASEORDERACHBANKTRANSFERIDEALPAYUKLARNA_INSTALLMENTKLARNA_PAY_LATEROTHERACCELAFFIRMAFFIRM_QRAFTERPAYALIPAY_PLUSALMAAMAZONPAYANCVATOMEBALOTOBANCONTACTBILLIEBIZUMBLIKBOLETOBANCARIOCARNETCARTES_BANCAIRESCASH_APP_PAYCLEARPAYCREDIT_CARDDANADIRECT_DEBITDOKU_VIRTUAL_ACCOUNTSDRAGONPAYDUITNOWEPSFISERVFPXGCASHGIROCARDGIROPAYGIVEXGOOGLEPAYGOPAYGRABPAYINTERSOLVEKAKAOPAYKLARNAKLARNA_PAY_NOWMBWAYMOBILE_PAYMOMOMULTIBANCONAVERPAYOXXOPAYBRIGHTPAYMEPAYPAYPAYPOPAYTMPAY_NOWPIXPROMPTPAYPURCHASE_ORDERRATEPAYRIVERTYSAMSUNG_PAYSCALAPAYSEPASOFORTSTORED_VALUE_SOLUTIONSSWISHTOSSPAYTOUCH_N_GOTWINTUNION_PAYVENMOVIPPSWIRE_TRANSFERYANDEXZAVERZIPShow 88 enum valuesperformanceLocationobject | nullWhere the service has been provided. Used for tax calculation and can be printed on documents.performanceLocation object | nullplanIdint64 | nulldeprecatedDEPRECATED. Deprecated: Reference to the Plan to use for the contract.planIdentstring | nullReference to the Plan to use for the contract.planModifiersarray | nullModifiers to apply to a plan and its options to change i.e. the price. Are applied only to this contract.planModifiersADD OptionPriceListModifierDtopropertiesarray of objects | nullAdditional contract properties to specify the contract.propertiesADD objectrelatedContractsarray of objects | nullContracts that might have a billing impact from this contract, for example, because they receive a commission.relatedContractsADD objectserviceLocationobject | nulldeprecatedDeprecated: Use taxLocation and performanceLocation instead. The location where the product or service was sold.serviceLocation object | nullshippingAddressIdint64 | nulldeprecatedDEPRECATED. Deprecated: Optional ID of the shipping address to which the contract will be assigned. Please use non-deprecated shippingAddressIdent.shippingAddressIdentstring | nullOptional ident of the shipping address to which the contract will be assigned.startDatedate-time | nullDefines start of the active period of the contract. Remains as is even if it was cancelled or terminated before activation start.taxLocationobject | nullWhere the service is taxable. Can be provided but might be overwritten during tax calculation.taxLocation object | nullResponses 201The request has been fulfilled, resulting in the creation of a new resource. 4XXerror response for all http error codes in range 4XX 5XXerror response for all http error codes in range 5XXUpdated 6 months ago Start billing runCancel contractsDid this page help you?YesNo