Attribute PAYG invoice to Cloud VPS servers

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

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

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

resources is always present: one plain-language row per metered resource (extra IPv4 addresses, CPU, memory, storage, data transfer) with the billed amount and approximate equivalents such as address count × days or average cores/GB over the period — use it to explain the invoice even when vms is empty (for example a floating-IP-only invoice on an account with no PAYG servers).

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

Invoices without PAYG line items return available: false.

Billing & Orders Invoices

Authentication

Required API scope: read:billing

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Path Parameters

id string required Example: inv_01hxa3b4c5d6e7f8g9h0j1k2m3

Public invoice ID from GET /api/v2/billing/invoices data[].id or invoice detail. 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-server attribution for the invoice's metered period, or an unavailable response for non-PAYG invoices.
Variant 1
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

Total amount apportioned across servers, in major units of currencyCode, excl. VAT. Per-server estimatedAmount values sum to this.

resources array<object> required

One row per metered resource on the invoice, with the billed amount (excl. VAT) and approximate plain-language equivalents. Always derivable from the invoice lines, so it is populated regardless of coverage. Sorted by amount, largest first.

resources[].key string · enum required · Example: ipv4
cpu
memory
storage
ipv4
bandwidth
resources[].amount number required · Example: 13.21

Billed amount for this resource, in major units of currencyCode, excl. VAT.

resources[].quantityHours number · Example: 440.5

Metered quantity in hours (core-hours, GB-hours, IP-hours). Absent for bandwidth rows.

resources[].quantityGb number · Example: 82.4

Metered quantity in GB. Bandwidth rows only.

resources[].ipCountApprox number · Example: 1

ipv4 only: approximate number of concurrent extra IPv4 addresses billed.

resources[].ipDaysApprox number · Example: 18

ipv4 only: approximate days each address was held.

resources[].averageCoresApprox number · Example: 3.5

cpu only: average vCPU cores in use across the metered period.

resources[].averageGbApprox number · Example: 8.2

memory/storage only: average GB in use across the metered period.

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[].firstObservedAt string · Example: 2026-05-31T00:00:00.000Z
vms[].lastObservedAt string · Example: 2026-06-30T00:00:00.000Z
vms[].latestObservedAt string · Example: 2026-07-06T00:00:00.000Z
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

This server's estimated share of attributedAmount, in major units of currencyCode, excl. VAT.

unattributedAmount number · Example: 12.5

Amount that could not be tied to a specific server, in major units of currencyCode, excl. VAT.

unattributedNote string · Example: Part of this invoice is metered usage that cannot be tied to a specific VM (e.g. object...
note string · Example: Per-VM usage recording covers only part of this invoice period, so per-VM amounts are a...
Variant 2
available boolean · enum required · Example: false
reason string required · Example: This invoice has no pay-as-you-go usage line items to attribute.
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 
// Variant 1
{
  "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,
  "resources": [
    {
      "key": "ipv4",
      "amount": 13.21,
      "quantityHours": 440.5,
      "quantityGb": 82.4,
      "ipCountApprox": 1,
      "ipDaysApprox": 18,
      "averageCoresApprox": 3.5,
      "averageGbApprox": 8.2
    }
  ],
  "vms": [
    {
      "id": "vps_06eywdj26ccqd4sg5qxm80pmyr",
      "name": "yopass",
      "displayName": "Password server",
      "firstObservedAt": "2026-05-31T00:00:00.000Z",
      "lastObservedAt": "2026-06-30T00:00:00.000Z",
      "latestObservedAt": "2026-07-06T00:00:00.000Z",
      "usage": {
        "cpuCoreHours": 1394,
        "ramGbHours": 2788,
        "diskGbHours": 34850,
        "bandwidthGb": 82.4,
        "ipHours": 697
      },
      "estimatedAmount": 64.2
    }
  ],
  "unattributedAmount": 12.5,
  "unattributedNote": "Part of this invoice is metered usage that cannot be tied to a specific VM (e.g. object storage, mail relay, or usage outside the recorded window).",
  "note": "Per-VM usage recording covers only part of this invoice period, so per-VM amounts are a lower bound for the covered days."
}

// Variant 2
{
  "available": false,
  "reason": "This invoice has no pay-as-you-go usage line items to attribute."
}