Estimate price

Overview

Before placing a catalog order, you can estimate the price in the number of UP42 credits for a specific product. The factors considered in the final price calculation are area of interest size, collection, and data product type.

Estimate a catalog order cost

To see a cost estimation before placing a catalog order, call the /workspaces/{workspace_id}/orders/estimate endpoint with the workspace ID as a path parameter.

Request

POST /workspaces/{workspace_id}/orders/estimate HTTP/1.1
Host: api.up42.com
Content-Type: application/json
Authorization: Bearer {token}

Parameter	Overview
`dataProduct`	string / required The data product ID.
`params`	object / required Order parameters. To get the payload schema, call the /orders/schema/{data_product_id} endpoint.
`tags`	array of strings A list of tags that categorize the order. You can use up to 30 tags.

See request example

{
  "dataProduct": "b1f8c48e-d16b-44c4-a1bb-5e8a24892e69",
  "params": {
    "id": "14e49010-9fab-4ba8-b4c5-ed929a083400",
    "aoi": {
      "type": "Polygon",
      "coordinates": [
        [
          [15.707442221277887, 51.446109645003816],
          [15.707442221277887, 51.05321657986457],
          [16.255864234092456, 51.05321657986457],
          [16.255864234092456, 51.446109645003816],
          [15.707442221277887, 51.446109645003816]
        ]
      ]
    }
  },
  "tags": ["project-7"]
}

Response

See response example

{
  "data": {
    "credits": 300
  },
  "error": null
}

Parameter	Overview
`data`	object The estimated price in UP42 credits.
`data.credits`	integer The estimated number of credits that may be consumed.