Get cost report totals (pay-as-you-go only)

Deprecated Use /v2/cost_report/breakdown instead.

The v2 report is different from this report:

• This report returns one row for each billing metric and region for the full period. The v2 report returns one row for each day and one group_by value.
• The v2 report moves billing_value, billing_value_unit, cost and currency to usage.value, usage.unit, usage.cost and usage.currency. The err field is error.
• The v2 flavor field also contains the volume_type, file_share_type and instance_type values.
• The v2 report has no billing_metric_name and billing_feature_name fields.
• The v2 request uses region_ids and project_ids. It has no schema_filter and rounding fields.

Get cost report totals (aggregated costs) for a given period. Requested period should not exceed 31 days.

Note: This report assumes there are no active commit features in the billing plan. If there are active commit features (pre-paid resources) in your plan, use /v1/reservation_cost_report/totals, as the results from this report will not be accurate.

Data from the past hour may not reflect the full set of statistics. For the most complete and accurate results, we recommend accessing the data at least one hour after the relevant time period. Updates are generally available within a 24-hour window, though timing can vary. Scheduled maintenance or other exceptions may occasionally cause delays beyond 24 hours.

POST /cloud/v1/cost_report/totals

Get cost report totals (pay-as-you-go only)

cURL

curl --request POST \
  --url https://api.gcore.com/cloud/v1/cost_report/totals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projects": [
    16,
    17,
    18,
    19,
    20
  ],
  "regions": [
    18,
    76
  ],
  "response_format": "json",
  "schema_filter": {
    "field": "flavor",
    "type": "instance",
    "values": [
      "g1-standard-1-2"
    ]
  },
  "tags": {
    "condition_type": "OR",
    "conditions": [
      {
        "key": "os_version",
        "strict": true,
        "value": "22.04"
      },
      {
        "key": "os_version",
        "strict": true,
        "value": "23.04"
      }
    ]
  },
  "time_from": "2024-08-01T00:00:00",
  "time_to": "2024-09-01T00:00:00",
  "types": [
    "egress_traffic",
    "instance"
  ]
}
'

200

{
  "count": 1,
  "price_status": "error",
  "results": [
    {
      "billing_feature_name": "AI Infrastructure: bm3-ai-1xlarge-h100-80-8 (2 x Intel Xeon 8480+, 2TB RAM, 8x3.84 TB NVMe, 8x Nvidia H100, IB 3.2 Tbit/s, 2x100Gbit/s Ethernet)  Luxembourg-2 - PAYG",
      "billing_metric_name": "bm3-ai-1xlarge-h100-80-8_min",
      "billing_value": 1000,
      "billing_value_unit": "minutes",
      "cost": 1000,
      "currency": "EUR",
      "err": null,
      "flavor": "bm3-ai-1xlarge-h100-80-8",
      "region": 76,
      "region_id": 76,
      "type": "ai_cluster"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Body

application/json

time_from · string<date-time> · required

The start date of the report period (ISO 8601). The report starts from the beginning of this day in UTC.

Example:

"2023-01-01T00:00:00Z"

time_to · string<date-time> · required

The end date of the report period (ISO 8601). The report ends just before the beginning of this day in UTC.

Example:

"2023-02-01T00:00:00Z"

enable_last_day · boolean · default: false

Expenses for the last specified day are taken into account. As the default, False.

Example:

false

projects · integer[]

List of project IDs

Example:

[16, 17, 18, 19, 20]

regions · integer[]

List of region IDs.

Example:

[1, 2, 3]

response_format · enum<string> · default: json

Format of the response (csv or json).

Available options: csv_totals, json

Examples:

"csv_totals"

"json"

rounding · boolean · default: true

Round cost values to 5 decimal places. When false, returns full precision.

schema_filter · SchemaFilterSnapshotSerializer · object

Extended filter for field filtering.

SchemaFilterSnapshotSerializer

SchemaFilterInstanceSerializer

SchemaFilterAiClusterSerializer

SchemaFilterAiVirtualClusterSerializer

SchemaFilterBasicVmSerializer

SchemaFilterBaremetalSerializer

SchemaFilterVolumeSerializer

SchemaFilterFileShareSerializer

SchemaFilterImageSerializer

SchemaFilterFloatingIpSerializer

SchemaFilterEgressTrafficSerializer

SchemaFilterLoadBalancerSerializer

SchemaFilterExternalIpSerializer

SchemaFilterBackupSerializer

SchemaFilterLogIndexSerializer

SchemaFilterFunctionsSerializer

SchemaFilterFunctionsCallsSerializer

SchemaFilterFunctionsTrafficSerializer

SchemaFilterContainersSerializer

SchemaFilterInferenceSerializer

SchemaFilterDBAASPostgreSQLVolumeSerializer

SchemaFilterDBAASPostgreSQLPublicNetworkSerializer

SchemaFilterDBAASPostgreSQLCPUSerializer

SchemaFilterDBAASPostgreSQLMemorySerializer

SchemaFilterDBAASPostgreSQLPoolerSerializer

Show child attributes

Example:

{
  "field": "flavor",
  "type": "instance",
  "values": ["g1-standard-1-2"]
}

tags · TagsFilterSerializer · object

Filter by tags

Show child attributes

Example:

{
  "condition_type": "OR",
  "conditions": [
    {
      "key": "os_version",
      "strict": true,
      "value": "22.04"
    },
    {
      "key": "os_version",
      "strict": true,
      "value": "23.04"
    }
  ]
}

types · enum<string>[]

List of resource types to be filtered in the report.

Resource types for prebilling report

Available options: ai_cluster, ai_virtual_cluster, backup, baremetal, basic_vm, containers, dbaas_postgresql_connection_pooler, dbaas_postgresql_cpu, dbaas_postgresql_memory, dbaas_postgresql_public_network, dbaas_postgresql_volume, egress_traffic, external_ip, file_share, floatingip, functions, functions_calls, functions_traffic, image, inference, inference_public_models, instance, load_balancer, log_index, snapshot, volume

Example:

["egress_traffic", "instance"]

Response

200

application/json

OK

count · integer · required

Count of returned totals

Required range: x >= 0

Example:

1

price_status · enum<string> · required

Price status for the UI, type: string

Available options: error, hide, show

results · (TotalAiClusterWithCostSerializer · object | TotalAiVirtualClusterWithCostSerializer · object | TotalBaremetalWithCostSerializer · object | TotalBasicVmWithCostSerializer · object | TotalBackupWithCostSerializer · object | TotalContainerWithCostSerializer · object | TotalEgressTrafficWithCostSerializer · object | TotalExternalIpWithCostSerializer · object | TotalFileShareWithCostSerializer · object | TotalFloatingIpWithCostSerializer · object | TotalFunctionsWithCostSerializer · object | TotalFunctionCallsWithCostSerializer · object | TotalFunctionEgressTrafficWithCostSerializer · object | TotalImagesWithCostSerializer · object | TotalInferenceWithCostSerializer · object | TotalInstanceWithCostSerializer · object | TotalLoadBalancerWithCostSerializer · object | TotalLogIndexWithCostSerializer · object | TotalSnapshotWithCostSerializer · object | TotalVolumeWithCostSerializer · object | TotalDBAASPostgreSQLPoolerWithCostSerializer · object | TotalDBAASPostgreSQLMemoryWithCostSerializer · object | TotalDBAASPostgreSQLPublicNetworkWithCostSerializer · object | TotalDBAASPostgreSQLCPUWithCostSerializer · object | TotalDBAASPostgreSQLVolumeWithCostSerializer · object)[] · required

TotalAiClusterWithCostSerializer

TotalAiVirtualClusterWithCostSerializer

TotalBaremetalWithCostSerializer

TotalBasicVmWithCostSerializer

TotalBackupWithCostSerializer

TotalContainerWithCostSerializer

TotalEgressTrafficWithCostSerializer

TotalExternalIpWithCostSerializer

TotalFileShareWithCostSerializer

TotalFloatingIpWithCostSerializer

TotalFunctionsWithCostSerializer

TotalFunctionCallsWithCostSerializer

TotalFunctionEgressTrafficWithCostSerializer

TotalImagesWithCostSerializer

TotalInferenceWithCostSerializer

TotalInstanceWithCostSerializer

TotalLoadBalancerWithCostSerializer

TotalLogIndexWithCostSerializer

TotalSnapshotWithCostSerializer

TotalVolumeWithCostSerializer

TotalDBAASPostgreSQLPoolerWithCostSerializer

TotalDBAASPostgreSQLMemoryWithCostSerializer

TotalDBAASPostgreSQLPublicNetworkWithCostSerializer

TotalDBAASPostgreSQLCPUWithCostSerializer

TotalDBAASPostgreSQLVolumeWithCostSerializer

Show child attributes