Attribute a PAYG invoice to Cloud VMs

GET /api/v2/billing/invoices/{id}/payg-breakdown

Attribute a pay-as-you-go usage invoice back to the Cloud VMs that generated the charges — including VMs deleted since.

PAYG is billed at the account level, so the invoice line items carry no VM identity; this sub-resource joins the invoice's metered period against recorded per-VM usage and apportions each resource amount by usage share, so per-VM amounts sum to attributedAmount.

coverage says how much of the period the recording spans: full (reliable), partial (amounts are a lower bound), or none (pre-recording invoice — vms lists which Cloud VMs existed in the window without amounts).

Invoices without PAYG line items return available: false.

Billing & Orders Invoices

Authentication

Required API scope: read:billing

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Path Parameters

id string required Example: inv_01hxa3b4c5d6e7f8g9h0j1k2m3

Public invoice ID. Get it from GET /api/v2/billing/invoices data[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>
Accept application/json

Responses

200 Per-VM attribution for the invoice's metered period, or an unavailable response for non-PAYG invoices.
available boolean · enum required · Example: true
true
period object required
period.startAt string required · Example: 2026-05-31T16:00:03.000Z
period.endAt string required · Example: 2026-06-30T00:00:00.000Z
coverage string · enum required · Example: full
full
partial
none
currencyCode string required · Example: SEK
amountsExclVat boolean · enum required · Example: true

All amounts in this response are pre-tax (excl. VAT); reconcile against the invoice subtotal, not the grand total.

true
attributedAmount number required · Example: 118.17
vms array<object> required
vms[].id string · nullable required · Example: vps_06eywdj26ccqd4sg5qxm80pmyr

Nullable: may be null when not applicable.

vms[].name string · nullable required · Example: yopass

Nullable: may be null when not applicable.

vms[].displayName string · Example: Password server
vms[].firstDate string · Example: 2026-05-31
vms[].lastDate string · Example: 2026-06-30
vms[].lastSeenDate string · Example: 2026-07-06
vms[].usage object
vms[].usage.cpuCoreHours number required · Example: 1394
vms[].usage.ramGbHours number required · Example: 2788
vms[].usage.diskGbHours number required · Example: 34850
vms[].usage.bandwidthGb number required · Example: 82.4
vms[].usage.ipHours number required · Example: 697
vms[].estimatedAmount number · Example: 64.2
unattributedAmount number · Example: 12.5
unattributedNote string · Example: Part of this invoice is account-level metered usage (e.g. object storage or mail relay)...
note string · Example: Per-VM usage recording covers only part of this invoice period, so per-VM amounts are a...
400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
GET https://cloud.hostup.se/api/v2/billing/invoices/{id}/payg-breakdown
For AI assistants
View as Markdown
cURL 
curl -X GET "https://cloud.hostup.se/api/v2/billing/invoices/inv_01hxa3b4c5d6e7f8g9h0j1k2m3/payg-breakdown" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Response 
{
  "available": true,
  "period": {
    "startAt": "2026-05-31T16:00:03.000Z",
    "endAt": "2026-06-30T00:00:00.000Z"
  },
  "coverage": "full",
  "currencyCode": "SEK",
  "amountsExclVat": true,
  "attributedAmount": 118.17,
  "vms": [
    {
      "id": "vps_06eywdj26ccqd4sg5qxm80pmyr",
      "name": "yopass",
      "firstDate": "2026-05-31",
      "lastDate": "2026-06-30",
      "lastSeenDate": "2026-07-06",
      "usage": {
        "cpuCoreHours": 1394,
        "ramGbHours": 2788,
        "diskGbHours": 34850,
        "bandwidthGb": 82.4,
        "ipHours": 697
      },
      "estimatedAmount": 118.17
    }
  ]
}