Preview Order

POST/order-previews/

API version

v2

Request method

POST

Operation ID

order-preview-order

---

Request

Responses

Format

application/json

Description

Schema documentation

• Alternativeobject
  • machineTypePricenumber

    required
  • storagePricenumber

    required
  • totalPricenumber

    required
• Alternativeobject
  • domainContractDurationnumber

    required

    Contract duration in months.

  • domainPricenumber

    required
  • feePricenumber

    required
  • totalPricenumber

    required
• Alternativeobject
  • feePricenumber

    required
  • recurringPricenumber

    required
  • totalPricenumber

    required

Example

Alternative #1

{
  "machineTypePrice": 500,
  "storagePrice": 1000,
  "totalPrice": 1500
}

Alternative #2

{
  "domainContractDuration": 12,
  "domainPrice": 800,
  "feePrice": 100,
  "totalPrice": 900
}

Alternative #3

{
  "feePrice": 900,
  "recurringPrice": 490,
  "totalPrice": 1390
}

JSON Schema

{
  "oneOf": [
    {
      "properties": {
        "machineTypePrice": {
          "example": 500,
          "type": "number"
        },
        "storagePrice": {
          "example": 1000,
          "type": "number"
        },
        "totalPrice": {
          "example": 1500,
          "type": "number"
        }
      },
      "required": [
        "totalPrice",
        "storagePrice",
        "machineTypePrice"
      ],
      "type": "object"
    },
    {
      "properties": {
        "domainContractDuration": {
          "description": "Contract duration in months.",
          "example": 12,
          "type": "number"
        },
        "domainPrice": {
          "example": 800,
          "type": "number"
        },
        "feePrice": {
          "example": 100,
          "type": "number"
        },
        "totalPrice": {
          "example": 900,
          "type": "number"
        }
      },
      "required": [
        "totalPrice",
        "domainPrice",
        "feePrice",
        "domainContractDuration"
      ],
      "type": "object"
    },
    {
      "properties": {
        "feePrice": {
          "example": 900,
          "type": "number"
        },
        "recurringPrice": {
          "example": 490,
          "type": "number"
        },
        "totalPrice": {
          "example": 1390,
          "type": "number"
        }
      },
      "required": [
        "totalPrice",
        "recurringPrice",
        "feePrice"
      ],
      "type": "object"
    }
  ]
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"orderData":{"customerId":"string","description":"My first project","diskspaceInGiB":20,"spec":{"machineType":"prospace.2cpu.4gb"}},"orderType":"domain"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/order-previews

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.contract.orderPreviewOrder({
  "data": {
    "orderData": {
      "customerId": "string",
      "description": "My first project",
      "diskspaceInGiB": 20,
      "spec": {
        "machineType": "prospace.2cpu.4gb"
      }
    },
    "orderType": "domain"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Contract\OrderPreviewOrder\OrderPreviewOrderRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Contract\OrderPreviewOrder\OrderPreviewOrderRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// OrderPreviewOrderRequestBody to learn how to construct a valid instance
$body = new OrderPreviewOrderRequestBody(/* TODO: ... */);

$request = (new OrderPreviewOrderRequest(
  body: $body
));
$response = $client->contract()->orderPreviewOrder($request);

var_dump($response->getBody();