Get frame price

You can check the price of a frame before purchase, by invoking the getFramePrice operation. You need to specify a valid contractID when requesting a price quotation with the getFramePrice operation, because the pricing model for catalog purchases is linked to your contract.

If you do not have a pricing model configured for your contract, contact the COSP team for assistance.

Required parameters

Contract ID

The contractID parameter specifies the contract associated with the purchase.

Frame ID

The frameID parameter specifies the frame that you wish to purchase.

EULA

The end user license agreement (EULA) defines the terms of use for purchased SAR products, also defining how widely products can be distributed. For full details of the EULA, see the relevant terms of your contract.

The eula parameter can take one of the following string values:

EULA Description

GOVERNMENT

This EULA option should be selected by a governmental organization that has contracted directly with ICEYE or by a reseller that plans to share products with a governmental organization. Government End Users shall use Products, Derivatives and Documentation solely under Government EULA.

STANDARD

This EULA option should be selected by a commercial organization that has contracted directly with ICEYE or by a reseller that plans to share products with a commercial organization. All other End Users than Government End Users shall use Products, Derivatives and Documentation solely under Standard EULA.

Example

Request

Enter the following curl command, remembering to replace the ${VARNAME} variables with the appropriate values:

curl -G --location "${API_BASE_URL}/api/catalog/v2/price" \
--header "Content-Type: application/json" \
--header "Accept: application/json, application/problem+json" \
--header "Authorization: Bearer ${API_ACCESS_TOKEN}" \
--data-urlencode "contractID=${contractID}" \
--data-urlencode "frameID=XXXXXXXXXX" \
--data-urlencode "eula=STANDARD"

Response

On success, returns a 200 status code and a JSON object containing the price quotation for purchasing the specified frame (where the price amount is expressed in the currency’s minor currency unit — see Currency units).

{
    "amount": 1000,
    "currency": "USD"
}