Raw schema
{
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Required unless you authenticate with the Authorization header (Bearer clientId:secret, or an OAuth access token issued for this server). The clientId returned by register_agent."
},
"secret": {
"type": "string",
"description": "Required unless you authenticate with the Authorization header (Bearer clientId:secret, or an OAuth access token issued for this server). The secret returned by register_agent."
},
"order": {
"type": "string",
"description": "The order id returned by create_order."
},
"accessToken": {
"type": "string",
"description": "The accessToken returned by create_order."
},
"offerVersion": {
"type": "string",
"description": "offer.version from the order, copied exactly."
},
"termsHash": {
"type": "string",
"description": "SHA-256 of the terms page in the language of the order: offer.terms[language].hash from the order, copied exactly. Sending it confirms that the buyer accepts those terms."
},
"billing": {
"type": "object",
"description": "The buyer as it will appear on the invoice and the contract. For type company, company, registration and representative are also required. For type person, leave out company, registration, vat and representative. No other keys are accepted.",
"required": [
"type",
"fullName",
"email",
"country",
"city",
"address"
],
"properties": {
"type": {
"type": "string",
"enum": [
"person",
"company"
]
},
"fullName": {
"type": "string",
"minLength": 3,
"maxLength": 150,
"description": "Full name of the buyer, or of the contact person for a company."
},
"email": {
"type": "string",
"maxLength": 254
},
"phone": {
"type": "string",
"minLength": 5,
"maxLength": 40,
"description": "Optional."
},
"country": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "ISO 3166-1 alpha-2 code, for example BG."
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"address": {
"type": "string",
"minLength": 3,
"maxLength": 250
},
"company": {
"type": "string",
"minLength": 2,
"maxLength": 200,
"description": "Company only. Registered name."
},
"registration": {
"type": "string",
"minLength": 4,
"maxLength": 40,
"description": "Company only. Company registration number; for country BG the 9- or 13-digit EIK."
},
"vat": {
"type": "string",
"minLength": 4,
"maxLength": 40,
"description": "Company only. Optional VAT number."
},
"representative": {
"type": "string",
"minLength": 3,
"maxLength": 150,
"description": "Company only. The person who legally represents the company."
}
},
"if": {
"properties": {
"type": {
"const": "company"
}
}
},
"then": {
"required": [
"company",
"registration",
"representative"
]
},
"additionalProperties": false
},
"immediateStart": {
"type": "boolean",
"description": "Natural persons only: true when the buyer expressly asks the work to start within the 14-day withdrawal period and acknowledges losing the right of withdrawal once the service is fully performed."
}
},
"required": [
"order",
"accessToken",
"offerVersion",
"termsHash",
"billing"
],
"additionalProperties": false
}