Generate pricing estimate

POST 
/pricing/estimate

Return an estimate and breakdown of the cost of a configuration

Request

application/json

Body

customer_name stringrequired

The customer's name

resources

object[]

required

Array [

resource string

quantity integer

]

customer_type CustomerTypeEnum (string)required

Possible values: [consumer, business]

currency

object

required

All 'currency[]' params are mutually exclusive, only one can be provided.

id string

iso_code string

country

object

required

All 'country[]' params are mutually exclusive, only one can be provided.

id string

iso_code2 string

iso_code3 string

Responses

200

Return an estimate and breakdown of the cost of a configuration

application/json

Schema

Schema

estimate

object

required

resources

object[]

Array [

resource string

description string

quantity integer

per_month float

per_month_inc_tax float

per_month_each float

per_hour float

per_hour_inc_tax float

per_hour_each float

package

object

nullable

id string

name string

permalink string

cpu_cores integer

ipv4_addresses integer

memory_in_gb integer

storage_in_gb integer

monthly_bandwidth_allowance_in_gb integernullable

privacy PrivacyTypesEnum (string)

Possible values: [public, private]

icon

object

nullable

url string

file_name string

file_type string

file_size integer

digest string

token string

use_dedicated_cpus boolean

group

object

id string

name string

]

per_month float

per_month_inc_tax float

per_hour float

per_hour_inc_tax float

currency

object

id string

name string

iso_code string

symbol string

tax_rate float

pdf_url string

Example (from schema)

{
  "estimate": {
    "resources": [
      {
        "resource": "string",
        "description": "string",
        "quantity": 0,
        "per_month": 0,
        "per_month_inc_tax": 0,
        "per_month_each": 0,
        "per_hour": 0,
        "per_hour_inc_tax": 0,
        "per_hour_each": 0,
        "package": {
          "id": "string",
          "name": "string",
          "permalink": "string",
          "cpu_cores": 0,
          "ipv4_addresses": 0,
          "memory_in_gb": 0,
          "storage_in_gb": 0,
          "monthly_bandwidth_allowance_in_gb": 0,
          "privacy": "public",
          "icon": {
            "url": "string",
            "file_name": "string",
            "file_type": "string",
            "file_size": 0,
            "digest": "string",
            "token": "string"
          },
          "use_dedicated_cpus": true,
          "group": {
            "id": "string",
            "name": "string"
          }
        }
      }
    ],
    "per_month": 0,
    "per_month_inc_tax": 0,
    "per_hour": 0,
    "per_hour_inc_tax": 0,
    "currency": {
      "id": "string",
      "name": "string",
      "iso_code": "string",
      "symbol": "string"
    },
    "tax_rate": 0,
    "pdf_url": "string"
  }
}

400

400 error response

application/json

Schema

Schema

oneOf

MissingResourcesSchema

You must provide at least one resource in the resources array

code MissingResourcesEnum (string)

Possible values: [missing_resources]

description string

detail object

InvalidEstimateResourceSchema

The provided resource is not valid

code InvalidEstimateResourceEnum (string)

Possible values: [invalid_estimate_resource]

description string

detail

object

resource stringnullable

InvalidEstimateQuantitySchema

The quantity for the provided resource must be greater than zero

code InvalidEstimateQuantityEnum (string)

Possible values: [invalid_estimate_quantity]

description string

detail

object

resource stringnullable

Example (from schema)

{}

403

403 error response

application/json

Schema

Schema

code InternalAuthErrorEnum (string)

Possible values: [internal_auth_error]

description string

detail

object

details string

Example (from schema)

{
  "code": "internal_auth_error",
  "description": "string",
  "detail": {
    "details": "string"
  }
}

404

404 error response

application/json

Schema

Schema

oneOf

CurrencyNotFoundSchema

No currency was found matching any of the criteria provided in the arguments

code CurrencyNotFoundEnum (string)

Possible values: [currency_not_found]

description string

detail object

CountryNotFoundSchema

No country was found matching any of the criteria provided in the arguments

code CountryNotFoundEnum (string)

Possible values: [country_not_found]

description string

detail object

Example (from schema)

{}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

Loading...