Get a cost estimate for a block storage volume

POST

https://api.americancloud.com/api/v1/storage/block-storage/cost-estimate

POST

/api/v1/storage/block-storage/cost-estimate

curl -X POST https://api.americancloud.com/api/v1/storage/block-storage/cost-estimate \
     -H "X-API-Client-ID: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "my-block-storage",
  "sizeGb": 100,
  "region": "us-west-0"
}'

{
  "estimates": {
    "hourly": {
      "base": 36,
      "discount": 7.2,
      "total": 28.8,
      "prorated": {
        "days_remaining": 15,
        "amount": 14.4
      }
    },
    "monthly": {
      "base": 36,
      "discount": 7.2,
      "total": 28.8,
      "prorated": {
        "days_remaining": 15,
        "amount": 14.4
      }
    }
  },
  "discount_applied": {
    "name": "20% off VMs",
    "percent": 20,
    "resource_types": [
      "Virtual Machine",
      "Block Storage"
    ]
  },
  "billing_note": "Nothing is charged now. Usage appears on your monthly bill, with a minimum of $5/month for 250 GB, prorated for your first partial month.",
  "metered": {
    "rate_per_gb_month": {
      "base": 36,
      "discount": 7.2,
      "total": 28.8,
      "prorated": {
        "days_remaining": 15,
        "amount": 14.4
      }
    },
    "minimum_gb": 250
  }
}

Returns the estimated cost for a volume with the given specs without creating it. Accepts the same body as create.

Authentication

X-API-Client-IDstring

API Client ID

X-API-Client-Secretstring

API Client Secret

Request

This endpoint expects an object.

namestringRequired

The name of the volume

sizeGbintegerRequired>=5

The size of the volume in GB

regionstringRequired

Label of the region where the volume will be created

Response

Cost estimate for the volume

estimatesobject

Cost estimates for the resource

discount_appliedobjectOptional

Discount applied to the estimate (if any)

billing_notestringOptional

Additional billing information or notes about pricing structure

meteredobjectOptional

The usage rate, for a resource that is billed by usage (object storage only).

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error