# Models

## The MetaData object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"MetaData":{"type":"object","properties":{"contractId":{"type":"integer"},"customerId":{"type":"integer"},"reference":{"type":"string","nullable":true}}}}}}
```

## The EvnItem object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"EvnItem":{"type":"object","properties":{"resourceType":{"$ref":"#/components/schemas/ResourceTypes"},"resourceUUID":{"type":"string","format":"uuid"},"intervalMin":{"type":"integer"},"intervalDivisor":{"type":"integer"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"itemStub":{"type":"string","enum":["A01000","ALB1000","ALB1100","C01000","C02000","C03000","CC1000","CR1000","CUBExxxx","CWSQL1001","CWSQL2001","CWSQL3001","CWSQL1000","CWSQL2000","DAS1000","NAT1000","NC1000","NLB1000","NLB1100","R01000","S01000","S02000","S03000","S05000","WL1000","WL2000","WL3000","WL4000","WL5000","WL6000"]},"value":{"type":"number"},"valueDivisor":{"type":"integer"},"additionalParameters":{"type":"string"}}},"ResourceTypes":{"type":"string","enum":["SERVER","STORAGE","SNAPSHOT","NATGATEWAY","NIC","IP","IP_ADDRESS","CUBETEMPLATE","LOADBALANCER","BACKUP","S3","TRAFFIC","DB","BMC","DBAAS","CRAAS","LAAS","DSAAS","DNS"]}}}}
```

## The Evn object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"Evn":{"type":"object","properties":{"metadata":{"allOf":[{"$ref":"#/components/schemas/MetaData"},{"type":"object","properties":{"period":{"type":"string"}}}]},"datacenters":{"type":"array","items":{"type":"object","properties":{"vdcUUID":{"type":"string","format":"uuid"},"name":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EvnItem"}}}}},"evnCSV":{"type":"array","items":{"type":"string"}}}},"MetaData":{"type":"object","properties":{"contractId":{"type":"integer"},"customerId":{"type":"integer"},"reference":{"type":"string","nullable":true}}},"EvnItem":{"type":"object","properties":{"resourceType":{"$ref":"#/components/schemas/ResourceTypes"},"resourceUUID":{"type":"string","format":"uuid"},"intervalMin":{"type":"integer"},"intervalDivisor":{"type":"integer"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"itemStub":{"type":"string","enum":["A01000","ALB1000","ALB1100","C01000","C02000","C03000","CC1000","CR1000","CUBExxxx","CWSQL1001","CWSQL2001","CWSQL3001","CWSQL1000","CWSQL2000","DAS1000","NAT1000","NC1000","NLB1000","NLB1100","R01000","S01000","S02000","S03000","S05000","WL1000","WL2000","WL3000","WL4000","WL5000","WL6000"]},"value":{"type":"number"},"valueDivisor":{"type":"integer"},"additionalParameters":{"type":"string"}}},"ResourceTypes":{"type":"string","enum":["SERVER","STORAGE","SNAPSHOT","NATGATEWAY","NIC","IP","IP_ADDRESS","CUBETEMPLATE","LOADBALANCER","BACKUP","S3","TRAFFIC","DB","BMC","DBAAS","CRAAS","LAAS","DSAAS","DNS"]}}}}
```

## The InvoiceTotal object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"InvoiceTotal":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}}}}}
```

## The InvoiceMeter object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"InvoiceMeter":{"type":"object","properties":{"meterId":{"type":"string"},"meterDesc":{"type":"string"},"productGroup":{"type":"string","nullable":true,"description":"Product group of the price item"},"quantity":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}},"rate":{"$ref":"#/components/schemas/InvoiceTotal"},"amount":{"$ref":"#/components/schemas/InvoiceTotal"}}},"InvoiceTotal":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}}}}}
```

## The Invoice object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"Invoice":{"type":"object","properties":{"metadata":{"type":"object","properties":{"invoiceId":{"type":"string"},"contractId":{"type":"integer"},"customerId":{"type":"integer"},"createdDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"postingPeriod":{"type":"string"},"finallyPosted":{"type":"boolean"},"reference":{"type":"string","nullable":true},"resellerRef":{"type":"string","nullable":true,"description":"Reference text or number for the subcontract set by the reseller"}}},"datacenters":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"location":{"type":"string"},"productGroup":{"type":"string","nullable":true,"description":"Product group of the data center"},"meters":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceMeter"}},"rebate":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/InvoiceTotal"}}}}}},"total":{"$ref":"#/components/schemas/InvoiceTotal"}}},"InvoiceMeter":{"type":"object","properties":{"meterId":{"type":"string"},"meterDesc":{"type":"string"},"productGroup":{"type":"string","nullable":true,"description":"Product group of the price item"},"quantity":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}},"rate":{"$ref":"#/components/schemas/InvoiceTotal"},"amount":{"$ref":"#/components/schemas/InvoiceTotal"}}},"InvoiceTotal":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}}}}}
```

## The Product object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"Product":{"type":"object","properties":{"meterId":{"type":"string","description":"Product code (just active will be provided)","enum":["A01000","AICL13I1000","AICL13O1000","AIDCI1000","AIDCI1100","AIDCI1200","AIDCS1000","AIFS1000","AIL3405I1000","AIL3405O1000","AIL370I1000","AIL370I1100","AIL370O1000","AIL370O1100","AIL38I1000","AIL38O1000","AIMNI1000","AIMNO1000","AIMSI1000","AIMSO1000","AIOI1000","AIOO1000","AISDXL1000","AIT7I1000","AIT7O1000","ALB1000","ALB1100","BA1100","BA1200","BA1300","BA1400","BA2000","BA3000","BA4000","BMCTO1000","BMCTO1100","BMCTO1200","BMCTO1300","BMCTO1400","BMCTO1500","BMCTO1600","BMCTO1700","BU1100","BU1200","BU1300","BU1400","BU1500","BU1600","BU1700","C01000","C010US","C02000","C03000","C04000","C05000","C06000","CDN1000","CRSU1000","CRVS1000","CTI1000","CTO0000","CTO1100","CTO1200","CTO1300","CTO1400","CUBES1100","CUBES1200","CUBES1300","CUBES1400","CUBES1500","CUBES1600","CUBES1700","CUBES1800","CUBES2100","CUBES2200","CUBES2210","CUBES2300","CUBES2310","CUBES2400","CUBES2410","CUBES2500","CUBES2510","CV1000","CWSQL1001","CWSQL2001","CWSQL3001","DBIMC1000","DBIMR1000","DBIMS3000","DBMAB1000","DBMAC1000","DBMAR1000","DBMAS2000","DBMAS3000","DBMB1000","DBMB1100","DBMB1200","DBMB1300","DBMB1400","DBMB1500","DBMB1600","DBMB1610","DBMBU1000","DBMEC1000","DBMER1000","DBMES1000","DBMES2000","DBMES3000","DBMP1000","DBMP1100","DBPGB1000","DBPGC1000","DBPGR1000","DBPGS1000","DBPGS2000","DBPGS3000","DNSP1000","DNSS1000","ESKA1100","ESKA1200","ESKA1300","ESKA1400","ESKA1500","LOGP1000","LOGS1000","MKC1000","MKCV1000","MKR1000","MKRV1000","MKS1000","MKS2000","MONS1000","MOSS1000","NAT1000","NFS1000","NLB1000","NLB1100","R01000","R010US","RHEL1100","RHEL1200","RHEL2100","RHEL2200","RHEL2300","RV1000","S01000","S02000","S03000","S05000","S3AU1100","S3AU1200","S3AU1300","S3AU2100","S3AU2200","S3RD1100","S3SR2000","S3SS2000","S3SU1000","S3SU1100","S3SU1200","S3SU1300","S3SU2000","S3TI1000","S3TI1100","S3TI2100","S3TI2200","S3TO1000","S3TO1100","S3TO2100","S3TO2200","S3TO2300","SPDC1000","SPDC3000","SPDR1000","SPDR3000","SPKC1000","SPKC3000","SPKR1000","SPKR3000","TI1000","TO1000","VPNG0800","VPNG0900","VPNG1000","VPNG1100","VPNG1200","VPNG1300","WAFR1000","WL1000","WL2000","WL3000","WL3050","WL3100","WL3200","WL4000","WL4050","WL4100","WL4200","WL5000","WL6000","WL6050","WL6100","WL6200","WL7100","WL7200","WL7250","WL7300","WL7400"]},"meterDesc":{"type":"string","description":"Product description (human readable)"},"deprecated":{"type":"boolean","description":"The flag specifies whether the product is marked as deprecated"},"unit":{"type":"string","description":"The unit applied for the product during computation"},"type":{"type":"string","description":"type of the billing (consumption-based or commitment-based)","enum":["commitment","consumption"]},"term":{"type":"integer","description":"length of the commitment period (only provided for commitment items) in months","nullable":true,"minimum":1},"unitCost":{"type":"object","nullable":true,"properties":{"quantity":{"type":"number"},"unit":{"type":"string","enum":["EUR","USD","CAD","GBP","MXN"]}}}}}}}}
```

## The TrafficEntry object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"TrafficEntry":{"type":"object","properties":{"Date":{"type":"string","format":"date"},"In":{"type":"number"},"Out":{"type":"number"}}}}}}
```

## The TrafficVDC object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"TrafficVDC":{"type":"object","properties":{"metadata":{"allOf":[{"$ref":"#/components/schemas/MetaData"},{"type":"object","properties":{"period":{"type":"string"},"unit":{"type":"string"}}}]},"trafficObj":{"type":"object","properties":{"vdc":{"type":"array","items":{"type":"object","properties":{"vdcUUID":{"type":"string","format":"uuid"},"vdcName":{"type":"string"},"dates":{"type":"array","items":{"$ref":"#/components/schemas/TrafficEntry"}}}}}}},"trafficArr":{"type":"array","items":{"type":"array","items":{"type":"string"}}},"traffic":{"type":"array","items":{"type":"string"}}}},"MetaData":{"type":"object","properties":{"contractId":{"type":"integer"},"customerId":{"type":"integer"},"reference":{"type":"string","nullable":true}}},"TrafficEntry":{"type":"object","properties":{"Date":{"type":"string","format":"date"},"In":{"type":"number"},"Out":{"type":"number"}}}}}}
```

## The TrafficNIC object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"TrafficNIC":{"type":"object","properties":{"metadata":{"allOf":[{"$ref":"#/components/schemas/MetaData"},{"type":"object","properties":{"period":{"type":"string"},"unit":{"type":"string"}}}]},"trafficObj":{"type":"object","properties":{"nic":{"type":"array","items":{"type":"object","properties":{"vdcUUID":{"type":"string","format":"uuid"},"vdcName":{"type":"string"},"ip":{"type":"string"},"dates":{"type":"array","items":{"$ref":"#/components/schemas/TrafficEntry"}}}}}}},"trafficArr":{"type":"array","items":{"type":"array","items":{"type":"string"}}},"traffic":{"type":"array","items":{"type":"string"}}}},"MetaData":{"type":"object","properties":{"contractId":{"type":"integer"},"customerId":{"type":"integer"},"reference":{"type":"string","nullable":true}}},"TrafficEntry":{"type":"object","properties":{"Date":{"type":"string","format":"date"},"In":{"type":"number"},"Out":{"type":"number"}}}}}}
```

## The UsageMeter object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"UsageMeter":{"type":"object","properties":{"meterId":{"type":"string","enum":["A01000","ALB1000","ALB1100","BU1100","BU1200","BU1300","BU1400","BU1500","C01000","C02000","C03000","CC1000","CR1000","CUBExxxx","CWSQL1001","CWSQL2001","CWSQL3001","CWSQL1000","CWSQL2000","DAS1000","DBPGB1000","DBPGC1000","DBPGR1000","DBPGS1000","DBPGS2000","DBPGS3000","NAT1000","NC1000","NLB1000","NLB1100","R01000","S01000","S02000","S03000","S05000","S3AU1100","S3AU1200","S3AU1300","S3RD1100","S3SU1100","S3SU1200","S3SU1300","S3TI1000","S3TI1100","S3TO1000","S3TO1100","S3TO1200","S3TO1300","S3TO1400","S3WR1100","TI1000","TO1000","WL1000","WL2000","WL3000","WL4000","WL5000","WL6000"]},"meterDesc":{"type":"string"},"quantity":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}}}}}}}
```

## The UsageDataCenter object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"UsageDataCenter":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"location":{"type":"string"},"meters":{"type":"array","items":{"$ref":"#/components/schemas/UsageMeter"}}}},"UsageMeter":{"type":"object","properties":{"meterId":{"type":"string","enum":["A01000","ALB1000","ALB1100","BU1100","BU1200","BU1300","BU1400","BU1500","C01000","C02000","C03000","CC1000","CR1000","CUBExxxx","CWSQL1001","CWSQL2001","CWSQL3001","CWSQL1000","CWSQL2000","DAS1000","DBPGB1000","DBPGC1000","DBPGR1000","DBPGS1000","DBPGS2000","DBPGS3000","NAT1000","NC1000","NLB1000","NLB1100","R01000","S01000","S02000","S03000","S05000","S3AU1100","S3AU1200","S3AU1300","S3RD1100","S3SU1100","S3SU1200","S3SU1300","S3TI1000","S3TI1100","S3TO1000","S3TO1100","S3TO1200","S3TO1300","S3TO1400","S3WR1100","TI1000","TO1000","WL1000","WL2000","WL3000","WL4000","WL5000","WL6000"]},"meterDesc":{"type":"string"},"quantity":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}}}}}}}
```

## The ResourceTypes object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"ResourceTypes":{"type":"string","enum":["SERVER","STORAGE","SNAPSHOT","NATGATEWAY","NIC","IP","IP_ADDRESS","CUBETEMPLATE","LOADBALANCER","BACKUP","S3","TRAFFIC","DB","BMC","DBAAS","CRAAS","LAAS","DSAAS","DNS"]}}}}
```

## The UtilizationMeter object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"UtilizationMeter":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"resourceId":{"type":"string","format":"uuid","nullable":true},"serverId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ResourceTypes"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"exists":{"type":"boolean","nullable":true},"meterId":{"type":"string","enum":["A01000","ALB1000","ALB1100","BU1100","BU1200","BU1300","BU1400","BU1500","C01000","C02000","C03000","CC1000","CR1000","CUBExxxx","CWSQL1001","CWSQL2001","CWSQL3001","CWSQL1000","CWSQL2000","DAS1000","DBPGB1000","DBPGC1000","DBPGR1000","DBPGS1000","DBPGS2000","DBPGS3000","NAT1000","NC1000","NLB1000","NLB1100","R01000","S01000","S02000","S03000","S05000","S3AU1100","S3AU1200","S3AU1300","S3RD1100","S3SU1100","S3SU1200","S3SU1300","S3TI1000","S3TI1100","S3TO1000","S3TO1100","S3TO1200","S3TO1300","S3TO1400","S3WR1100","TI1000","TO1000","WL1000","WL2000","WL3000","WL4000","WL5000","WL6000"]},"meterDesc":{"type":"string"},"region":{"type":"string"},"quantity":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}}}},"ResourceTypes":{"type":"string","enum":["SERVER","STORAGE","SNAPSHOT","NATGATEWAY","NIC","IP","IP_ADDRESS","CUBETEMPLATE","LOADBALANCER","BACKUP","S3","TRAFFIC","DB","BMC","DBAAS","CRAAS","LAAS","DSAAS","DNS"]}}}}
```

## The UtilizationDataCenter object

```json
{"openapi":"3.0.0","info":{"title":"IONOS Cloud Billing API","version":"3.9.0"},"components":{"schemas":{"UtilizationDataCenter":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"meters":{"type":"array","items":{"$ref":"#/components/schemas/UtilizationMeter"}}}},"UtilizationMeter":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"resourceId":{"type":"string","format":"uuid","nullable":true},"serverId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/ResourceTypes"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"exists":{"type":"boolean","nullable":true},"meterId":{"type":"string","enum":["A01000","ALB1000","ALB1100","BU1100","BU1200","BU1300","BU1400","BU1500","C01000","C02000","C03000","CC1000","CR1000","CUBExxxx","CWSQL1001","CWSQL2001","CWSQL3001","CWSQL1000","CWSQL2000","DAS1000","DBPGB1000","DBPGC1000","DBPGR1000","DBPGS1000","DBPGS2000","DBPGS3000","NAT1000","NC1000","NLB1000","NLB1100","R01000","S01000","S02000","S03000","S05000","S3AU1100","S3AU1200","S3AU1300","S3RD1100","S3SU1100","S3SU1200","S3SU1300","S3TI1000","S3TI1100","S3TO1000","S3TO1100","S3TO1200","S3TO1300","S3TO1400","S3WR1100","TI1000","TO1000","WL1000","WL2000","WL3000","WL4000","WL5000","WL6000"]},"meterDesc":{"type":"string"},"region":{"type":"string"},"quantity":{"type":"object","properties":{"quantity":{"type":"number"},"unit":{"type":"string"}}}}},"ResourceTypes":{"type":"string","enum":["SERVER","STORAGE","SNAPSHOT","NATGATEWAY","NIC","IP","IP_ADDRESS","CUBETEMPLATE","LOADBALANCER","BACKUP","S3","TRAFFIC","DB","BMC","DBAAS","CRAAS","LAAS","DSAAS","DNS"]}}}}
```