API docs by Redocly

IONOS Cloud Billing API (3.9.0)

Download OpenAPI specification:Download

Overview

The IONOS Billing API is a REST API that can be used to retrieve information about resource usage and invoices. Information on usage is provided without liability.

Access Permissions

Both Contract Owners and Contract Admins have access to the data, but Contract Admins for Reseller Sub-Contracts do not have permission to access the /invoices endpoint.

evn

EVN data

evnGet

Returns provisioning itemized data for a current month

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "datacenters": [
    ],
  • "evnCSV": [
    ]
}

evnFindByPeriod

Returns provisioning itemized data for a certain period

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

period
required
string or null^(\d{4}-\d{2}|null)$
Example: 2020-01

Period of interest in format YYYY-MM

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "datacenters": [
    ],
  • "evnCSV": [
    ]
}

internal

Internal data

internalPingGet

Check the API health

Authorizations:
basicAuthbearerAuth

Responses

invoices

Invoice data

invoicesGet

Returns a list of all invoices.

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "invoices": [
    ]
}

invoicesFindById

Returns the invoice for a given invoice ID.

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

id
required
string

Invoice ID

query Parameters
dateformat
string

Vendor date format

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "datacenters": [
    ],
  • "total": {
    }
}

invoicesFindByPeriod

Returns invoices of billing profiles of a use.

Authorizations:
basicAuthbearerAuth
path Parameters
period
required
string^\d{4}-\d{2}$
Example: 2020-01

Period of interest in format YYYY-MM

query Parameters
contractid
string

Filter out the exact contractID

dateformat
string

Vendor date format

Responses

Response samples

Content type
application/json
[
  • {
    }
]

traffic

Traffic data

trafficGet

Get a high-granularity list of utilization resources for current month by default

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

query Parameters
ip
boolean

Provide report grouped by IPs

output
string
Default: "all"
Enum: "all" "obj" "arr" "csv"

The output format (object, array, CSV or all of them)

Responses

Response samples

Content type
application/json
{
  • "type": "vdc",
  • "trafficObj": {
    },
  • "trafficArr": [
    ],
  • "traffic": [
    ]
}

trafficFindByPeriod

Get a high-granularity list of utilization resources for a certain period

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

period
required
string or null^(\d{4}-\d{2}|null)$
Example: 2020-01

Period of interest in format YYYY-MM

query Parameters
ip
boolean

Provide report grouped by IPs

output
string
Default: "all"
Enum: "all" "obj" "arr" "csv"

The output format (object, array, CSV or all of them)

Responses

Response samples

Content type
application/json
{
  • "type": "vdc",
  • "trafficObj": {
    },
  • "trafficArr": [
    ],
  • "traffic": [
    ]
}

utilization

Utilization data

utilizationGet

Get a high-granularity data of resources utilization

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

query Parameters
dc
string <uuid>

Filter out by particular VDC UUID (or "Bucket" UUID for non-vdc related resources)

resource
string <uuid>

Filter out by particular resource UUID (e.g.VM UUID, NIC UUID)

type
string (ResourceTypes)
Enum: "SERVER" "STORAGE" "SNAPSHOT" "NATGATEWAY" "NIC" "IP" "IP_ADDRESS" "CUBETEMPLATE" "LOADBALANCER" "BACKUP" "S3" "TRAFFIC" "DB" "BMC" "DBAAS" "CRAAS" "LAAS" "DSAAS" "DNS"

Filter out by particular type of items

Responses

Response samples

Content type
application/json
{
  • "startDate": "2020-01-01",
  • "endDate": "2020-01-12",
  • "datacenters": [
    ],
  • "metadata": {
    }
}

utilizationFindByPeriod

Get a high-granularity data of resources utilization for a certain period

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

period
required
string or null^(\d{4}-\d{2}|null)$
Example: 2020-01

Period of interest in format YYYY-MM

query Parameters
dc
string <uuid>

Filter out by particular VDC UUID (or "Bucket" UUID for non-vdc related resources)

resource
string <uuid>

Filter out by particular resource UUID (e.g.VM UUID, NIC UUID)

type
string (ResourceTypes)
Enum: "SERVER" "STORAGE" "SNAPSHOT" "NATGATEWAY" "NIC" "IP" "IP_ADDRESS" "CUBETEMPLATE" "LOADBALANCER" "BACKUP" "S3" "TRAFFIC" "DB" "BMC" "DBAAS" "CRAAS" "LAAS" "DSAAS" "DNS"

Filter out by particular type of items

Responses

Response samples

Content type
application/json
{
  • "startDate": "2020-01-01",
  • "endDate": "2020-01-12",
  • "datacenters": [
    ],
  • "metadata": {
    }
}

profile

Profile data

profileGet

Retrieves the billing profile(s) of the authenticated account

Authorizations:
basicAuthbearerAuth

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ]
}

products

Product data

productsGet

Returns a list of products available for the given contract (only billable and active)

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

contract number

query Parameters
date
string <date>
Example: date=2025-01-01

Date of interest in format of YYYY-MM-DD

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "liability": "Please double check your contract for prices.",
  • "products": [
    ]
}

usage

Usage data

usageGet

Returns the usage of a contract

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

query Parameters
period
string^\d{4}-\d{2}$

Period of interest in format YYYY-MM (current month by default if not specified)

Responses

Response samples

Content type
application/json
{
  • "startDate": "2020-01-01",
  • "endDate": "2020-01-12",
  • "datacenters": [
    ],
  • "metadata": {
    }
}

usageFindByDC

Returns the usage of a contract for a given data-center

Authorizations:
basicAuthbearerAuth
path Parameters
contract
required
string <int32> [0-9]{5,10}

Contract number

dc
required
string or null^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4...
Example: ad34b997-43c7-4666-889b-57acbeaeeb8b

Get data for the particular data-center ID (VDC UUID)

query Parameters
period
string^\d{4}-\d{2}$

Period of interest in format YYYY-MM (current month by default if not specified)

Responses

Response samples

Content type
application/json
{
  • "startDate": "2020-01-01",
  • "endDate": "2020-01-12",
  • "datacenters": [
    ],
  • "metadata": {
    }
}