Skip to content

Prices endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

Parameter In Type Required
workspaceId path string (uuid) yes
cursor query string no
limit query integer (int32) or string (int32) no
Status Meaning Body
200 OK PageOfPriceEntryDto
Parameter In Type Required
workspaceId path string (uuid) yes

Request body (application/json): CustomPriceRequest

Field Type Required Notes
provider string yes
region string or null yes
sku string yes
description string or null yes
unit string yes
unitPrice number (double) or string (double) or null yes pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
currency string yes
effectiveDate string (date) yes
Status Meaning Body
201 Created PriceEntryDto

DELETE /api/workspaces/{workspaceId}/prices/{priceId}

Section titled “DELETE /api/workspaces/{workspaceId}/prices/{priceId}”
Parameter In Type Required
workspaceId path string (uuid) yes
priceId path string (uuid) yes
Status Meaning Body
204 No Content none

GET /api/workspaces/{workspaceId}/prices/azure/meters

Section titled “GET /api/workspaces/{workspaceId}/prices/azure/meters”
Parameter In Type Required
workspaceId path string (uuid) yes
serviceName query string no
region query string no
skuName query string no
meterName query string no
currency query string no
Status Meaning Body
200 OK AzureMeterPage
502 Bad Gateway ErrorResponse

POST /api/workspaces/{workspaceId}/prices/azure

Section titled “POST /api/workspaces/{workspaceId}/prices/azure”
Parameter In Type Required
workspaceId path string (uuid) yes

Request body (application/json): AzureImportRequest

Field Type Required Notes
meterId string yes
skuId string or null yes
armRegionName string or null yes
currency string yes
Status Meaning Body
201 Created PriceEntryDto
502 Bad Gateway ErrorResponse